Gneisswork Documentation
Welcome to the Gneisswork documentation! Choose a topic from the navigation below.
Quick Links
- Getting Started — Installation and first steps
- Web UI Guide — Using the web interface
- API Reference — REST API endpoints
- Data Models — Database schema and models
- CSV Export — Export format and compatibility
- Reference Data — Customizing lithologies and structures
- Architecture — Technical overview
- Contributing — How to contribute
- Android APK Build — Building the Android APK
- Legacy Mobile App — Original Cordova app history
Overview
Gneisswork is a free and open-source web application for field geological and sedimentological core logging. It’s designed to help geologists create detailed sedimentary logs in the field using any device with a browser.
Key Features
- Create and manage multiple sedimentary log profiles
- Record detailed bed-by-bed data
- Drag-and-drop bed reordering
- CSV export compatible with SedLog
- Customizable reference data
- No internet connection required
Technology Stack
- Backend: Python 3.10+, Flask 3.0+
- Database: SQLite with Flask-SQLAlchemy 3.1+
- Frontend: HTML5, CSS3, vanilla JavaScript
- Testing: Pytest
Getting Help
- Issues: Report bugs on GitHub Issues
- Main Repository: github.com/stark1tty/Gneisswork