A geological data platform for exploration, integration, and analysis (v2).
This repository represents the core of the Macrostrat system, containing its database schema and control scripts to maintain it. As such, it provides a "build recipe" for the open-source core of Macrostrat, which in v2 will be provided publicly as a runnable platform for curating geologic maps and other datasets.
The core component packaged here is a Python application designed to control various aspects of Macrostrat's system and supporting processes (e.g., map caching and harmonization).
- Command-line interface: A Python-based CLI for managing Macrostrat's system components
- Map ingestion system: Scripts for importing geologic maps into Macrostrat's database
Macrostrat's core services are housed in the services/ directory:
- API v3: An API for managing Macrostrat elements, and authentication
- Macrostrat task runner: coming soon
Other Macrostrat services (e.g., read-only APIs) are housed in other repositories.
The project is built using uv. It is required to have uv installed on your system.
UV can be installed directly instructions here.
Alternatively, we recommend mise to manage UV and Python versions.
Some services (notably the legacy tileserver) use older versions of Python or other languages entirely.
- Running
makewill install the Python dependencies and build the application. make testwill run the test suite.make installwill install the application into the local root.
Setting the MACROSTRAT_PYROOT environment variable allows a different root
Python version to be installed. This can be used to add new plugins
or application dependencies.
- Run
macrostrat uv syncto ensure that all dependencies are installed.
Once a Macrostrat configuration file is defined, the Macrostrat command-line app presents a broad list of management functionality for Macrostrat's system. Subsystems (in progress) define functionality for specific aspects of the system.
This CLI is rapidly evolving so expect breakage! When in doubt run make, or ~equivalently
uv sync to update your installation.
Documentation is a work in progress. We have starting points for:
-
Macrostrat in a Box, a future Docker Compose-based setup for running Macrostrat locally on a single host
-
Map staging scripts: ad-hoc scripts for scraping vector maps from the web and uploading to Macrostrat
Other documentation of general interest can be found in the docs/ directory.