Frequently Asked Questions (FAQ)#
Use these questions to find the next guide for your task. The answers are intentionally brief; follow the links for prerequisites, procedures, and details.
Getting Started#
Where should I begin if I have never used MsPASS?#
Follow the desktop quick start to launch a first local session, then use the User Manual introduction for a guided tour of the main concepts.
Where can I find complete, worked examples?#
After completing the desktop quick start, work through the MsPASS tutorial notebooks with a small data set.
Choosing a Runtime#
Which runtime should I use for a first local session?#
Start with the single-container Docker guide. If you prefer a graphical interface, see the optional MsPASS Desktop launcher.
When should I use Docker Compose?#
Use the multi-container Docker Compose guide when you need the main services in separate containers on one Docker host.
When should I install MsPASS with Conda?#
Read the Conda installation guide when you need a local environment for development or a non-container installation.
Where should I start for a cluster or hosted environment?#
Read the virtual-cluster concepts before using the HPC deployment guide or the EarthScope GeoLab guide.
Data and Database Concepts#
What objects represent waveform data in MsPASS?#
The seismic data object concepts page introduces the core data and metadata containers used throughout MsPASS.
How does MsPASS organize and access stored data?#
Begin with database concepts, then use the CRUD operations guide for the create, read, update, and delete interfaces.
What database schema should I use?#
The schema selection guide explains how the choice depends on whether a workflow is exploratory or moving toward production. For collection and attribute definitions, use the MsPASS schema reference.
How do I import waveform data and tabular metadata?#
Start with the waveform-data import guide and use the tabular-data import guide for metadata stored in formats such as CSV files or pandas data frames.
Processing and Troubleshooting#
How does MsPASS handle continuous data?#
See continuous data handling for the data model and workflow patterns used for long, segmented records.
What should I do when data or an algorithm fails?#
Use the error-handling guide to understand error logs, live and dead data, and failure behavior in processing workflows.
Where can I find the available processing algorithms?#
Use the algorithm quick reference to find operations on MsPASS seismic data objects. See adapting an existing algorithm when an external algorithm needs a MsPASS interface.
Where do I look up a class, function, or module?#
Use the Python API reference for the current Python module hierarchy and the C++ API reference for the core C++ interfaces.
Scaling and Development#
When should I parallelize a workflow?#
Validate the serial workflow first, then read the parallel processing guide before choosing a scheduler or increasing scale. For resource bottlenecks, continue to the memory-management, I/O, and parallel-I/O guides.
How do I develop a new workflow from scratch?#
The workflow development guide presents a progression from small Python workflows to more complex algorithm adapters.