PySeismoSoil

Table of Contents

• 1. Copyright and license
• 2. Authors
• 3. Installation
• 4. Supported Python versions
• 5. API Documentation
• 6. Examples
• 7. Knowledge base
• 8. Report issues
• 9. How to cite this library
• 10. How to contribute to this library

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 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 of the California Institute of Technology: Jian Shi, Domniki Asimaki, Wei Li, and Flora Xia.

3. Installation

Install most recent stable version:

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]

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]

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]

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]

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]

8. Report issues

To report bugs and submit suggestions, please use the "Issues" section of this GitHub repository.

9. How to cite this library

To cite this library, please include this DOI in your publication: .

10. How to contribute to this library

Please read the contributing instructions to get started.