Metadata-Version: 2.1
Name: fdhpy
Version: 1.0.1
Summary: Implementations of FDHI Project Fault Displacement Models
Author-email: Alex Sarmiento <asarmy@ucla.edu>
License: MIT
Project-URL: repository, https://github.com/asarmy/fdhpy
Project-URL: homepage, https://github.com/NHR3-UCLA/FDHI_FDM
Keywords: fault displacement,seismic hazard,fdhpy
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: AUTHORS.rst
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: scipy
Requires-Dist: attrs>=24.2.0
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"

# fdhpy
![CI](https://github.com/asarmy/fdhpy/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/fdhpy/raw/coverage-data-branch/badge.svg)
[![DOI](https://zenodo.org/badge/829626950.svg)](https://zenodo.org/doi/10.5281/zenodo.13552790)
[![Documentation Status](https://readthedocs.org/projects/fdhpy/badge/?version=latest)](https://fdhpy.readthedocs.io/en/latest/)
[![PyPI version](https://img.shields.io/pypi/v/fdhpy.svg)](https://pypi.org/project/fdhpy/)
![Downloads](https://pepy.tech/badge/fdhpy)

## Overview
Fault displacement models implemented in Python.

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

See the [Quick Usage Guide](https://fdhpy.readthedocs.io/en/latest/usage.html) or the examples in [this notebook](https://github.com/asarmy/fdhpy/blob/main/examples/examples.ipynb) to get started.

## Credits
Code Development by Alex Sarmiento with direct contributions from Grigorios Lavrentiadis, Albert Kottke, Nicolas Kuehn, and Arash Zandieh.

## License
This project is licensed under the MIT License. See the [LICENSE](https://github.com/NHR3-UCLA/FDHI_FDM/blob/main/LICENSE) file for details.

## Citing this Work
If you use this software, please cite it using the following DOI: [![DOI](https://zenodo.org/badge/829626950.svg)](https://zenodo.org/doi/10.5281/zenodo.13552790).
