.. sgsim documentation master file.

Welcome to SGSIM's Documentation!
==================================

SGSIM is a Python library for Stochastic Ground Motion Simulation and Analysis.

SGSIM provides tools for:

* Stochastic Simulation and Modeling of Earthquake Ground Motions
* Ground Motion Analysis

This documentation provides installation, examples, and a comprehensive public API reference.

.. toctree::
   :maxdepth: 1
   :caption: Installation

   source/installation

.. toctree::
   :maxdepth: 1
   :caption: Examples

   source/examples_index

.. toctree::
   :maxdepth: 2
   :caption: API Reference

   source/api