Skip to main content

Simulations of spatial networks growth

Project description

Reticuler

PyPI Documentation Status Code style: black

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

Documentation

Setup

External dependencies:

FreeFEM++ - PDE solver

Package installation

pip install reticuler

Usage

During the installation four command line scripts are installed:

  • reticulate - runs the simulation
  • reticulate_back - runs the the Backward Evolution Algorithm
  • clip_ret - clips the network to one of the growth thresholds (maximum forward evolution step, length, height, evolution time, or BEA step)
  • plot_ret - plots the network based on the .json file from the simulation

To use just type in the command line: reticulate -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

Bifurcation dynamics of natural drainage networks, A. Petroff, O. Devauchelle, H. Seybold, and D. H. Rothman. Philos. Trans. Royal Soc. A 371, no. 2004 (2013): 20120365.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

reticuler-1.1.tar.gz (30.1 kB view details)

Uploaded Source

Built Distribution

reticuler-1.1-py3-none-any.whl (36.5 kB view details)

Uploaded Python 3

File details

Details for the file reticuler-1.1.tar.gz.

File metadata

  • Download URL: reticuler-1.1.tar.gz
  • Upload date:
  • Size: 30.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.12

File hashes

Hashes for reticuler-1.1.tar.gz
Algorithm Hash digest
SHA256 3311a0994d2c5776d0e39b57c21e44036eb3a51bc2d0b9d731b46c7a9d826631
MD5 832ace0509226e6aa776f4d08edb160c
BLAKE2b-256 8cb0a92092896aebcfe1356833ec6464fde5eb2cb76a38f50d4e06f2f74d4365

See more details on using hashes here.

Provenance

File details

Details for the file reticuler-1.1-py3-none-any.whl.

File metadata

  • Download URL: reticuler-1.1-py3-none-any.whl
  • Upload date:
  • Size: 36.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.12

File hashes

Hashes for reticuler-1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 84a033024445de70b5bd7b72048ee82cada67d0846eeaf5683df246b0fe291c5
MD5 7603ea2d2fe41a9159069a2d625a9a15
BLAKE2b-256 c3287a6e44c96bd74322712ab8bc6c141f2793d4aa45d58b0f80f076f22f6e92

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page