Metadata-Version: 2.4
Name: plans
Version: 1.1.2
Summary: A simulation tool for planning nature-based solutions in watershed conservation projects
Author: Iporã Possantti, Rafael Barbedo, Marcelo Kronbauer, Guilherme Fernandes Marques
Maintainer: Iporã Possantti, Rafael Barbedo
License-Expression: GPL-3.0-or-later
Project-URL: Homepage, https://github.com/iporepos/plans
Keywords: python,watershed conservation,nature-based solutions,ecosystem services,water resources,hydrology,topmodel,hillslope hydrology
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: scipy
Requires-Dist: pandas
Requires-Dist: geopandas
Requires-Dist: rasterio
Requires-Dist: Pillow
Provides-Extra: dev
Requires-Dist: black==25.12.0; extra == "dev"
Requires-Dist: notebook; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"
Requires-Dist: pydata-sphinx-theme; extra == "docs"
Requires-Dist: sphinx_copybutton; extra == "docs"
Requires-Dist: myst-parser; extra == "docs"
Requires-Dist: sphinx_design; extra == "docs"
Dynamic: license-file

![Style Status](https://github.com/iporepos/plans/actions/workflows/style.yaml/badge.svg)
![Docs Status](https://github.com/iporepos/copyme/actions/workflows/docs.yaml/badge.svg)
![Tests Status](https://github.com/iporepos/plans/actions/workflows/tests.yaml/badge.svg)
![Top Language](https://img.shields.io/github/languages/top/iporepos/copyme)
[![Documentation](https://img.shields.io/badge/docs-online-blue)](https://iporepos.github.io/plans/)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.17142043.svg)](https://doi.org/10.5281/zenodo.17142043)
[![PyPI Latest Release](https://img.shields.io/pypi/v/plans.svg?label=PyPI)](https://pypi.org/project/plans/)
[![PyPI Downloads](https://img.shields.io/pypi/dm/plans.svg?label=PyPI%20downloads)](
https://pypi.org/project/plans/)

<a logo>
<img src="https://github.com/iporepos/plans-assets/blob/main/docs/figs/logo.jpg?raw=true" height="130" width="130">
</a>


---

# plans

A simulation tool that supports watershed conservation 
projects in planning the expansion of nature-based solutions for water
at the hillslope scale.

<a example2>
<img src="https://github.com/iporepos/plans-assets/blob/main/docs/figs/about.jpg?raw=true">
</a>

> [!NOTE]
> Check out the [documentation website](https://iporepos.github.io/plans/) for more info.

---

## Quick Gallery

Mapping riparian wetlands dynamics during infiltration event:

<a example2>
<img src="https://github.com/iporepos/plans-assets/blob/main/docs/gallery/example2.gif?raw=true">
</a>


---

# Installation

As a Python package in any OS:

```bash
python -m pip install plans
```

As a Windows 11 application:

1. Install Python 3 (add to PATH during installation);
2. Download ``install-plans.ps1`` from the GitHub repository;
3. Run ``install-plans.ps1`` with ``PowerShell``.


> [!NOTE]
> See more details in the [documentation website](https://iporepos.github.io/plans/)


---

# Repository layout

```txt
plans/
  │
  ├── LICENSE
  ├── README.md                     # this file (landing page)
  ├── ...                           # configuration files
  │
  ├── src/                          # source code
  │    └── plans/                   # library
  ├── tests/                        # testing resources
  ├── docs/                         # documentation resources 
  ├── dev/                          # development resources 
  └── examples/                     # learning resources       

```
