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). Materials

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-2.0.tar.gz (33.1 kB view details)

Uploaded Source

Built Distribution

reticuler-2.0-py3-none-any.whl (39.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for reticuler-2.0.tar.gz
Algorithm Hash digest
SHA256 a38ab301cf13044150062edd6ba1b21cecc997ff1cd29a22f5d0ceedc197914b
MD5 e635d5a6ec899229b1ecefafce8915fd
BLAKE2b-256 68deb4b37b152d96340c75b2c833dd9c6fb26aedc33ea65dbd0da72885a18012

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for reticuler-2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 615cb5119093cd6628eab19c60d5aed583e256d3008e6ceff3bcaacf0b470d82
MD5 d0d6aa5008e6634b6330ab88a403736c
BLAKE2b-256 72e158d669ba35e2e9abaafffed01b6beca3c0d62420829f51c7f39d0d83b9c1

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