Metadata-Version: 2.1
Name: reticuler
Version: 1.0
Summary: Simulations of spatial networks growth
Author: Stanisław Żukowski
Author-email: zukowski.st@gmail.com
License: MIT
Project-URL: Source, https://github.com/stzukowski/reticuler
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE

# Reticuler

<p align="center">
<a href="https://pypi.org/project/reticuler/"><img alt="PyPI" src="https://img.shields.io/pypi/v/reticuler"></a>
<a href='https://reticuler.readthedocs.io/en/latest/?badge=latest'><img src='https://readthedocs.org/projects/reticuler/badge/?version=latest' alt='Documentation Status'/></a>
<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
</p>

Python package to simulate the growth of spatial networks in nature.

[Documentation](https://reticuler.readthedocs.io/en/latest/)

## Setup

### External dependencies:
[__FreeFEM++__](https://freefem.org/) - PDE solver

### Package installation
```
pip install reticuler
```

## Usage

During installation two command line scripts are installed:
- *reticulate* - runs the simulation
- *plot_ret* - plots the network based on the *.json* file from the simulation

To use just type in the command line:
`reticulate -h`
or
`plot_ret -h`

Typical network growth simulation:
- output file: *test*,
- growth threshold type: maximum network height,
- growth threshold: 2
```
reticulate -out test --growth_params {\"growth_thresh_type\":1,\"growth_thresh\":2}
```

## How to cite
*Through history to growth dynamics: backward evolution of spatial networks*, S. Żukowski, P. Morawiecki, H. Seybold, P. Szymczak, Sci Rep 12, 20407 (2022). https://doi.org/10.1038/s41598-022-24656-x

### References
[1]: [P. Morawiecki, *Problem odwrotny do ewolucji sieci rzecznych* (2016)](http://www.fuw.edu.pl/~piotrek/theses/PMorawiecki.pdf).

[2]: [S. Żukowski, *Związek między geometrią sieci rzecznych a prawami ich wzrostu* (2019)](http://www.fuw.edu.pl/~piotrek/theses/SZukowski.pdf).

[3]: [S. Żukowski, *Backward evolution of river networks* (2021)](http://www.fuw.edu.pl/~piotrek/theses/SZukowski2.pdf).
