Skip to content

Latest commit

 

History

171 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SGSIM Logo

SGSIM: Simulation and Analysis of Ground Motions

Python License PyPI Documentation Status DOI

SGSIM is a Python package that provides two main capabilities:

  1. Simulation of earthquake ground motions using a site-compatible stochastic method [1].
  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

Core stable version (recommended): Install the latest stable version from PyPI:

pip install sgsim

GUI stable version:
If you want to use the graphical user interface locally, install with gui:

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:

pip install git+https://github.com/Sajad-Hussaini/sgsim.git

Documentation & License

📖 Explore the Full Documentation, Tutorials, and API Reference available at sgsim.readthedocs.io.

SGSIM is distributed under the GNU General Public License v3 (GPLv3). See the 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

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

Releases

Packages

Contributors

Languages