Metadata-Version: 2.4
Name: sgsim
Version: 1.6.1
Summary: Simulation and Analysis of Ground Motions
Author-email: Sajad Hussaini <hussaini.smsajad@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/Sajad-Hussaini/sgsim
Project-URL: Documentation, https://sgsim.readthedocs.io
Project-URL: Repository, https://github.com/Sajad-Hussaini/sgsim
Project-URL: Issues, https://github.com/Sajad-Hussaini/sgsim/issues
Project-URL: Changelog, https://github.com/Sajad-Hussaini/sgsim/releases
Keywords: sgsim,stochastic ground motion simulation,ground motion analysis,earthquake engineering
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: numba
Provides-Extra: gui
Requires-Dist: dash; extra == "gui"
Requires-Dist: dash-bootstrap-components; extra == "gui"
Requires-Dist: plotly; extra == "gui"
Requires-Dist: pandas; extra == "gui"
Requires-Dist: gunicorn; extra == "gui"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx_rtd_theme; extra == "docs"
Requires-Dist: sphinx-copybutton; extra == "docs"
Requires-Dist: myst-parser; extra == "docs"
Requires-Dist: nbsphinx; extra == "docs"
Requires-Dist: pygments; extra == "docs"
Requires-Dist: pydata-sphinx-theme; extra == "docs"
Dynamic: license-file

<div align="center">
  <img src="https://raw.githubusercontent.com/Sajad-Hussaini/sgsim/main/src/sgsim/gui/assets/logo.png" alt="SGSIM Logo" width="300"/>
  <br>
  <h1>SGSIM: Simulation and Analysis of Ground Motions</h1>

  <p>
    <a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/python-3.10+-blue.svg" alt="Python"></a>
    <a href="https://opensource.org/licenses/GPL-3.0"><img src="https://img.shields.io/badge/license-GPLv3-blue.svg" alt="License"></a>
    <a href="https://pypi.org/project/sgsim"><img src="https://img.shields.io/pypi/v/sgsim.svg" alt="PyPI"></a>
    <a href="https://sgsim.readthedocs.io/en/latest/?badge=latest"><img src="https://readthedocs.org/projects/sgsim/badge/?version=latest" alt="Documentation Status"></a>
    <a href="https://doi.org/10.5281/zenodo.14565922"><img src="https://img.shields.io/badge/DOI-10.5281%2Fzenodo.14565922-blue.svg" alt="DOI"></a>
  </p>
</div>  

**SGSIM** is a Python package that provides two main capabilities:  
> 1. **Simulation** of earthquake ground motions using a site-compatible stochastic method [[1]](#references).  
> 2. **Processing and analysis** of ground motions, including filtering, trimming, and calculating various intensity measures (e.g., PGA, SA, FAS, etc.).


## Table of Contents
- [Installation](#installation)
- [Documentation & License](#documentation--license)
- [Contact & Support](#contact--support)
- [References](#references)

## Installation
**Core stable version (recommended):** Install the latest stable version from [PyPI](https://pypi.org/project/sgsim):
```bash
pip install sgsim
```

**GUI stable version:**  
If you want to use the graphical user interface locally, install with `gui`:
```bash
pip install sgsim[gui]
```
*After installing, simply run `sgsim` in your terminal to launch the interface.*

**Development version:**  
To use the latest development version, install directly from the [GitHub repository](https://github.com/Sajad-Hussaini/sgsim):
```bash
pip install git+https://github.com/Sajad-Hussaini/sgsim.git
```

## Documentation & License
📖 **[Explore the Full Documentation, Tutorials, and API Reference](https://sgsim.readthedocs.io/)** available at [sgsim.readthedocs.io](https://sgsim.readthedocs.io/en/latest/?badge=latest).


**SGSIM** is distributed under the [**GNU General Public License v3 (GPLv3)**](https://opensource.org/licenses/GPL-3.0). See the [LICENSE](LICENSE) file for the full text.

> You are free to use, modify, and distribute this software for academic and research purposes. Any commercial use or distribution of modified versions requires the entire project to be open-sourced under the same GPLv3 license. For proprietary commercial exemptions, please refer to the Contact section.

## Contact & Support
For any questions, assistance, suggestions, or requests to implement additional Intensity Measures (IMs), please feel free to contact:

**S. M. Sajad Hussaini**  
📧 [hussaini.smsajad@gmail.com](mailto:hussaini.smsajad@gmail.com)

> Please include "SGSIM" in the subject line for a quicker response.

## References

Please cite the following references for any formal study:  

**[1] Primary Reference**  
*Broadband Stochastic Simulation of Earthquake Ground Motions with Multiple Strong Phases with an Application to the 2023 Kahramanmaraş, Turkey (Türkiye), Earthquake*  
*DOI: https://doi.org/10.1177/87552930251331981*  
(Journal of Earthquake Spectra)

**[2] SGSIM Package**  
*Simulation and Analysis of Ground Motions*  
*DOI: https://doi.org/10.5281/zenodo.14565922*
