Metadata-Version: 2.3
Name: pySPADS
Version: 0.0.2
Summary: Implementation of the SPADS shoreline prediction algorithm from the paper 'A Multiscale Approach to Shoreline Prediction' by Montano et. al. (2020).
Author-email: Nelis Drost <nelis.drost@gmail.com>
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Dist: bokeh>=3.2.2
Requires-Dist: click>=8.1.7
Requires-Dist: colorcet>=3.1.0
Requires-Dist: EMD-signal>=1.5.1
Requires-Dist: geopandas>=0.14.0
Requires-Dist: matplotlib>=3.8.0
Requires-Dist: numpy>=1.26.0
Requires-Dist: pandas>=2.1.0
Requires-Dist: pydantic>=2.7.4
Requires-Dist: PyYAML>=6.0.1
Requires-Dist: scikit-learn>=1.3.2
Requires-Dist: scipy>=1.11.2
Requires-Dist: seaborn>=0.12.2
Requires-Dist: shapely>=2.0.1
Requires-Dist: snakemake>=8.12.0
Requires-Dist: tqdm>=4.64.1
Requires-Dist: mat73==0.62 ; extra == "dev"
Requires-Dist: spinx ; extra == "dev"
Requires-Dist: sphinx_rtd_theme ; extra == "dev"
Requires-Dist: sphinx-click ; extra == "dev"
Requires-Dist: tox ; extra == "test"
Requires-Dist: pytest==8.2.2 ; extra == "test"
Requires-Dist: hypothesis ; extra == "test"
Requires-Dist: pytest-mock ; extra == "test"
Project-URL: Documentation, https://pySPADS.readthedocs.io
Project-URL: Repository, https://github.com/UoA-eResearch/pySPADS
Provides-Extra: dev
Provides-Extra: test

# pySPADS
**pySPADS** is an implementation of the "Shoreline Prediction at Different Time-Scales" (SPADS) algorithm developed in the paper ["A Multiscale Approach to Shoreline Prediction" by Montano et. al. (2020).](https://agupubs.onlinelibrary.wiley.com/doi/10.1029/2020GL090587)

## Work-in-progress
This package is functionally complete, and contains all the logic necessary to run the SPADS analysis. 
However, the documentation, CLI and more usage examples are still a work in progress.

The most useful resources for understanding how to use the package are the [example scripts](https://github.com/UoA-eResearch/pySPADS/tree/main/scripts), along with the [example data](https://github.com/UoA-eResearch/pySPADS/tree/main/data/example_run) in the project repository. 
