MsPASS Documentation

MsPASS (Massive Parallel Analysis System for Seismologists) is an open-source framework for seismic data processing and management. It has three core components:

• A scalable parallel-processing framework based on a dataflow model.

• A NoSQL document-store data-management system.

• A container-based environment for deployment and reproducible processing.

MsPASS builds on the ObsPy toolkit and C++ components derived from SEISPP.

Choose your path

• First-time desktop users: Follow the desktop quick start, then choose the single-container Docker guide or the MsPASS Desktop graphical launcher.

• Data-processing users: Begin with seismic data objects, continue to database concepts, and then browse the processing algorithms.

• Cluster deployers: Read the virtual-cluster concepts before following the HPC deployment guide or a platform-specific deployment page.

• API readers: Go directly to the Python API, C++ API, or MsPASS schema.

Concepts and Architecture

• Introduction
• MsPASS Components

Start on a Desktop

• Fast path: desktop quick start
• Single-container Docker guide
• Graphical launcher: MsPASS Desktop
• Advanced Docker CLI and Compose overview
• Multi-container Docker Compose deployment
• Conda installation
• Advanced setup considerations

Clusters and Hosted Environments

• Virtual-cluster concepts
• HPC deployment
• HPC launcher configuration
• Conda and Coiled deployment
• EarthScope GeoLab

Seismic Data Foundations

• Data Object Design Concepts
• Using NumPy and SciPy with MsPASS
• Using ObsPy with MsPASS
• Time Standard Constraints
• Processing History Concepts
• Continuous Data Handling with MsPASS

Database and Data Ingestion

• Database Concepts
• What database schema should I use?
• Using MongoDB with MsPASS
• CRUD Operations in MsPASS
• Normalization
• Importing Data
• Importing Tabular Data

Processing Workflows

• Algorithms
• Handling Errors
• Data Editing
• Cleaning Inconsistent Metadata
• Header (Metadata) Math
• Signal to Noise Ratio Estimation
• Arrival Time Measurement Techniques in MsPASS
• Deconvolution Operators
• Graphics in MsPASS
• Adapting an Existing Algorithm to MsPASS

Scaling and Performance

• Parallel Processing
• Memory Management
• I/O in MsPASS
• Parallel IO in MsPASS

Help and Workflow Development

• Frequently Asked Questions (FAQ)
• How do I develop a new workflow from scratch?

API and Schema Reference

• Python API
  • mspasspy.algorithms
  • mspasspy.ccore
  • mspasspy.client
  • mspasspy.db
  • mspasspy.global_history
  • mspasspy.graphics
  • mspasspy.history
  • mspasspy.io
  • mspasspy.preprocessing
  • mspasspy.reduce
  • mspasspy.seismic
  • mspasspy.util
  • mspasspy.workflow
• C++ API
  • MsPASS C++ API
  • mspass::utility::Metadata
  • mspass::seismic::TimeSeries
  • mspass::seismic::Seismogram
• MsPASS schema
  • Database Collections
  • All Valid Attributes
  • Master Documents for Normalized Attributes
  • Attributes with Conceptual Relationship