.. SeisGo documentation master file

SeisGo Documentation
====================

**SeisGo** is an open-source Python package for seismic data analysis, ambient noise seismology,
seismic monitoring, and related workflows. It provides a unified, high-level interface covering
everything from raw data download through cross-correlation, stacking, dispersion analysis,
anisotropy measurement, and velocity model clustering.

- **GitHub**: https://github.com/xtyangpsp/SeisGo
- **License**: MIT

.. toctree::
   :maxdepth: 1
   :caption: Getting Started

   guides/installation
   guides/quickstart
   guides/data_formats

.. toctree::
   :maxdepth: 1
   :caption: User Guides

   guides/ambient_noise_workflow
   guides/monitoring_workflow
   guides/dispersion_workflow
   guides/anisotropy_workflow
   guides/clustering_workflow
   guides/simulation_workflow

.. toctree::
   :maxdepth: 1
   :caption: API Reference

   api/noise
   api/stacking
   api/monitoring
   api/dispersion
   api/anisotropy
   api/clustering
   api/simulation
   api/utils
   api/types
   api/plotting
   api/downloaders
   api/hvsr
   api/helpers

.. toctree::
   :maxdepth: 1
   :caption: Reference

   reference/conventions
   reference/changelog

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`