Metadata-Version: 2.4
Name: PySeismoSoil
Version: 0.7.0
Summary: A Python library for performing 1D seismic site response analysis
Author: PySeismoSoil Contributors
License: BSD-3-Clause
Project-URL: Homepage, https://caltech-geoquake.github.io/PySeismoSoil/
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: PyWavelets>=1.3.0
Requires-Dist: matplotlib>=2.0.0
Requires-Dist: numba>=0.38.0
Requires-Dist: numpy>=2.4.0
Requires-Dist: scipy>=1.1.0
Dynamic: license-file

# PySeismoSoil

<!--TOC-->

______________________________________________________________________

**Table of Contents**

- [1. Copyright and license](#1-copyright-and-license)
- [2. Authors](#2-authors)
- [3. Installation](#3-installation)
- [4. Supported Python versions](#4-supported-python-versions)
- [5. API Documentation](#5-api-documentation)
- [6. Examples](#6-examples)
- [7. Knowledge base](#7-knowledge-base)
- [8. Report issues](#8-report-issues)
- [9. How to cite this library](#9-how-to-cite-this-library)
- [10. How to contribute to this library](#10-how-to-contribute-to-this-library)

______________________________________________________________________

<!--TOC-->

[![PyPI](https://img.shields.io/pypi/v/pyseismosoil)](https://pypi.org/project/PySeismoSoil/)
[![Docs](https://github.com/Caltech-geoquake/PySeismoSoil/actions/workflows/build-and-deploy-docs.yml/badge.svg?branch=main)](https://github.com/Caltech-geoquake/PySeismoSoil/actions/workflows/build-and-deploy-docs.yml)
[![Downloads](https://static.pepy.tech/badge/pyseismosoil)](https://pepy.tech/project/pyseismosoil)
[![Downloads](https://static.pepy.tech/badge/pyseismosoil/month)](https://pepy.tech/project/pyseismosoil)
[![Downloads](https://static.pepy.tech/badge/pyseismosoil/week)](https://pepy.tech/project/pyseismosoil)

PySeismoSoil is a Python library for performing 1D seismic site response
analysis.

## 1. Copyright and license

Copyright (c) 2024, California Institute of Technology, based on research
supported by the National Science Foundation (NSF) Cooperative Agreement
EAR-1033462 and the U.S. Geological Survey (USGS) Cooperative Agreement
G12AC20038. All rights reserved.

Please carefully read the license
[here](https://caltech-geoquake.github.io/PySeismoSoil/blob/master/LICENSE) for
the terms and conditions of using this library.

## 2. Authors

The authors of this library are the current and past members of the
[Geoquake Research Group](http://asimaki.caltech.edu/) of the
[California Institute of Technology](https://www.caltech.edu/): Jian Shi,
Domniki Asimaki, Wei Li, and Flora Xia.

## 3. Installation

Install most recent stable version:

```bash
pip install PySeismoSoil
```

If you already have an older version installed and want to upgrade to the
newest version, use `pip install --upgrade PySeismoSoil`.

## 4. Supported Python versions

PySeismoSoil currently support these Python versions:

- 3.11
- 3.12
- 3.13

## 5. API Documentation

https://caltech-geoquake.github.io/PySeismoSoil/

## 6. Examples

Go to the "examples" folder from the root directory. Those examples help you
quickly get familiar with the usage of this library.

## 7. Knowledge base

The models and algorithms used in this library mainly come from these research
papers:

1. J. Shi (2019) "Improving Site Response Analysis for Earthquake Ground Motion
   Modeling." _Dissertation (Ph.D.), California Institute of Technology_.
   doi:10.7907/X5NZ-DQ21.
   \[[URL](http://resolver.caltech.edu/CaltechTHESIS:05302019-150220368)\]

2. J. Shi, D. Asimaki (2018) "A Generic Velocity Profile for Basin Sediments in
   California Conditioned on Vs30." _Seismological Research Letters_, 89 (4),
   1397-1409.
   \[[URL](http://resolver.caltech.edu/CaltechAUTHORS:20180523-153705346)\]

3. J. Shi, D. Asimaki (2017) "From stiffness to strength: Formulation and
   validation of a hybrid hyperbolic nonlinear soil model for site-response
   analyses." _Bulletin of the Seismological Society of America_, 107 (3),
   1336-1355.
   \[[URL](http://resolver.caltech.edu/CaltechAUTHORS:20170404-150827374)\]

4. W. Li, D. Assimaki (2010) "Site- and motion-dependent parametric uncertainty
   of site-response analyses in earthquake simulations." _Bulletin of the
   Seismological Society of America_, 100 (3), 954-968.
   \[[URL](http://resolver.caltech.edu/CaltechAUTHORS:20140904-160952252)\]

5. D. Asimaki, W. Li, J. Steidl, J. Schmedes (2008) "Quantifying nonlinearity
   susceptibility via site-response modeling uncertainty at three sites in the
   Los Angeles Basin." _Bulletin of the Seismological Society of America_, 98
   (5), 2364-2390.
   \[[URL](http://resolver.caltech.edu/CaltechAUTHORS:20140828-163417572)\]

## 8. Report issues

To report bugs and submit suggestions, please use the
["Issues" section](https://github.com/jsh9/PySeismoSoil/issues) of this GitHub
repository.

## 9. How to cite this library

To cite this library, please include this DOI in your publication:
[![DOI](https://zenodo.org/badge/169386936.svg)](https://zenodo.org/badge/latestdoi/169386936).

## 10. How to contribute to this library

Please read the
[contributing instructions](https://caltech-geoquake.github.io/PySeismoSoil/blob/master/CONTRIBUTING.md)
to get started.
