Macrostrat Documentation

Macrostrat seeks to provide an integrated geologic description of the Earth's crust at multiple scales. The following documentation is intended to help Users consume Macrostrat's data and services and Administrators deploy and develop Macrostrat.

User Documentation

This section contains documentation for users of Macrostrat's web services, APIs, and data products.

QGIS integration

API documentation

General API Docs

Documentation for Macrostrat's general purpose API

Macrostrat API tutorials

Ingestion API Docs

Documentation for Macrostrat's ingestion API

Ingestion API Docs

Documentation for General use Postgrest API

Tileserver API Docs

Documentation for Tileserver API

Contributor documentaion

Ingestion

Documentation for ingesting data into Macrostrat

Administrator documentation

This section contains documentation for administrating Macrostrat's web services. This includes guides to setting up and maintaining Macrostrat's services.

Codebase

This is an index of the software repositories that are being contributed to as part of the Macrostrat / UW–Madison CriticalMAAS effort.

Macrostrat core system

The repositories in Macrostrat's core system will eventually contain the minimum set of capabilities required to run a functioning instance of Macrostrat. They will contain the primary deliverables of the CriticalMAAS project and will be designed to be well-documented and runnable by USGS staff.

  • UW-Macrostrat/macrostrat: Macrostrat's core system, including its database definitions, control scripts, and ingestion pipelines. This repository is the primary focus of the CriticalMAAS project.
  • UW-Macrostrat/tileserver: Server for vector and raster tiles to GIS software
  • UW-Macrostrat/web: Macrostrat's main web interface
  • UW-Macrostrat/api-v3: Macrostrat's v3 API, which will be the primary API for CriticalMAAS capabilities

Reusable libraries

Macrostrat maintains shared libraries that underpin a variety of activities including CriticalMAAS.

Web Components

Shared React/Typescript user interface components for rich map-based user interfaces

Github

Python Libraries

Python libraries used throughout Macrostrat server and control applications, including tools for database access and data processing.

Github

Geologic metadata curation

  • UW-Macrostrat/macrostrat-xdd: System to synthesize xDD-driven geologic unit descriptions from the scientific literature (placeholder for future development)
  • UW-Macrostrat/factsheet-generator: An LLM-assisted generator for geological "fact sheets" that operates over the scientific literature (Bill Xia; Computer Science)
  • UW-Macrostrat/unsupervised-kg: Knowledge graph construction to discover new geologic entities in the scientific literature (Devesh Sarda; Computer Science)
  • UW-Macrostrat/map-metadata-curation: Documentation of efforts to align current archive of maps with Macrostrat v2 data standards. Focus on point data, raster image alignment, and ingestion metadata recovery (Kate Akin; Geoscience)

Integrations

Macrostrat is integrated with systems that provide additional functionality relevant to CriticalMAAS. Major adjustments to these systems are out-of-scope for the CriticalMAAS project, but integrations with Macrostrat can provide useful capabilities to the CriticalMAAS program.

  • Mapboard topology-manager: Topological map manager for PostGIS databases (for editing TA1 maps and topologically synthesizing them for Macrostrat output layers)
  • Corelle: Paleogeographic rotation system compatible with GPlates
  • xDD: A system for extracting geologic metadata from the scientific literature
  • Mapboard GIS: An iPad-based GIS for geologists, with a focus on rapid, intuitive drawing (for TA1 map editing if required)
  • Weaver: Ingestion, curation, performant filtering, and visualization of massive geological point datasets (for TA2 data integration)

Map interface examples

The v2.macrostrat.org/dev and v2.macrostrat.org/map/dev websites contain examples of Macrostrat's map services for raster, vector, and point-based data.

Document extraction