Metadata-Version: 2.2
Name: kuehn_et_al_fdm
Version: 1.0.2
Summary: Implementations of the Kuehn et al. 2024 Fault Displacement Model
Author: Alex Sarmiento
License: MIT
Project-URL: homepage, https://github.com/asarmy/kuehn_et_al_fdm
Project-URL: repository, https://github.com/asarmy/kuehn_et_al_fdm
Project-URL: documentation, https://kuehn-et-al-fdm.readthedocs.io/en/latest/index.html
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: AUTHORS.rst
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: scipy
Provides-Extra: examples
Requires-Dist: jupyter; extra == "examples"
Requires-Dist: matplotlib; extra == "examples"
Requires-Dist: statsmodels; extra == "examples"
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: sphinx; extra == "dev"
Requires-Dist: sphinx_rtd_theme; extra == "dev"
Requires-Dist: sphinxcontrib-bibtex; extra == "dev"
Requires-Dist: pydocstyle; extra == "dev"
Requires-Dist: myst-parser; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: toml; extra == "dev"
Requires-Dist: build; extra == "dev"

# kuehn_et_al_fdm

![CI](https://github.com/asarmy/kuehn_et_al_fdm/actions/workflows/CI.yml/badge.svg)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
![Coverage](https://github.com/asarmy/kuehn_et_al_fdm/raw/coverage-data-branch/badge.svg)
[![Documentation Status](https://readthedocs.org/projects/kuehn-et-al-fdm/badge/?version=latest)](https://kuehn-et-al-fdm.readthedocs.io/en/latest/)
[![DOI](https://zenodo.org/badge/841573158.svg)](https://zenodo.org/doi/10.5281/zenodo.13308173)
[![PyPI version](https://img.shields.io/pypi/v/fdhpy.svg)](https://pypi.org/project/kuehn-et-al-fdm/)
![Downloads](https://pepy.tech/badge/kuehn-et-al-fdm)

## Overview

Python Implementation of the Kuehn et al. (2024) Fault Displacement Model.

The model is documented in:
> Kuehn NM, Kottke AR, Sarmiento AC, Madugo CM and Bozorgnia Y (2024). A fault displacement model based on the FDHI database: *Earthquake Spectra*, Epub ahead of print, DOI: 10.1177/87552930241291077.


To install the package, follow the instructions in the [Installation Guide](https://kuehn-et-al-fdm.readthedocs.io/en/latest/installation.html).

See the [Quick Usage Guide](https://kuehn-et-al-fdm.readthedocs.io/en/latest/usage.html) to get started.

## License

This project is licensed under the MIT License. See the [LICENSE](https://github.com/asarmy/kuehn_et_al_fdm/blob/main/LICENSE) file for details.

## Citing this Work

If you use this software in your research, please cite it using the following DOI: [![DOI](https://zenodo.org/badge/841573158.svg)](https://zenodo.org/doi/10.5281/zenodo.13308173).
