Metadata-Version: 2.4
Name: idfva
Version: 0.1.0
Summary: This model generates investigation polygons which are used to estimate and store incremental erosion and deposition volumes along the path of a debris flow at user- defined resolution. The user will need: 1) a .LAS or .TIF of topographic change, 2) a DEM of the AOI, and 3) a shapefile (polyline) of the debris flow path of interest. Each incremental volume is georeferenced and stored within a shapefile attribute associated with a catchment area and distance from outlet for analysis.
Project-URL: Homepage, https://https://github.com/laurenguido/IncrementalDerisFlowVolumeAnalyzer
Project-URL: Source Code, https://https://github.com/laurenguido/IncrementalDerisFlowVolumeAnalyzer/tree/main/idfva
Project-URL: Bug Tracker, https://https://github.com/laurenguido/IncrementalDerisFlowVolumeAnalyzer/blob/main/CHANGELOG.md
Project-URL: Documentation, https://https://csdms.colorado.edu/wiki/Model:IncrementalDebrisFlowVolumeAnalyzer
Project-URL: Download, https://pypi.org/project/idfva/#files
Author-email: Lauren Guido <laurenmiller@mines.edu>
License-Expression: MIT
License-File: LICENSE
Keywords: debris flow,erosion,erosion/deposition,flow path,hazards,lateral erosion
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Typing :: Typed
Requires-Python: >=3.10
Requires-Dist: fiona
Requires-Dist: laspy
Requires-Dist: matplotlib
Requires-Dist: numba>=0.59
Requires-Dist: numpy
Requires-Dist: pyproj
Requires-Dist: pysheds
Requires-Dist: rasterio
Requires-Dist: scipy
Requires-Dist: shapely
Provides-Extra: dev
Requires-Dist: hatch; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Description-Content-Type: text/markdown

# Welcome to idfva

|        |        |
|--------|--------|
| Package | [![Latest PyPI Version](https://img.shields.io/pypi/v/idfva.svg)](https://pypi.org/project/idfva/) [![Supported Python Versions](https://img.shields.io/pypi/pyversions/idfva.svg)](https://pypi.org/project/idfva/) [![Documentation](https://readthedocs.org/projects/idfva/badge/?version=latest)](https://idfva.readthedocs.io/en/latest/?badge=latest) |
| Meta   | [![Code of Conduct](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md) |

*TODO: the above badges that indicate python version and package version will only work if your package is on PyPI.
If you don't plan to publish to PyPI, you can remove them.*

idfva is a project that (describe what it does here).

## Get started

You can install this package into your preferred Python environment using pip:

```bash
$ pip install idfva
```

TODO: Add a brief example of how to use the package to this section

To use idfva in your code:

```python
>>> import idfva
>>> idfva.hello_world()
```

## Copyright

- Copyright © 2025 Lauren Guido.
- Free software distributed under the [MIT License](./LICENSE).
