reticuler 5.0

Simulations of spatial networks growth

Reticuler

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

Documentation

Setup

External dependencies:

FreeFEM++ - PDE solver

Package installation

pip install reticuler

Usage

Four command line scripts are installed during the installation:

• 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
• script_ret - prepares a FreeFEM++ script based on the .json file

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

Typical network growth simulation:

reticulate -out test --growth_params {\"growth_thresh_type\":1,\"growth_thresh\":2}

• output file: test,
• growth threshold type: maximum network height,
• growth threshold: 2

How to cite

[1] Through history to growth dynamics: backward evolution of spatial networks, S. Żukowski, P. Morawiecki, H. Seybold, P. Szymczak, Sci. Rep. 12, 20407 (2022).

[2] Breakthrough-induced loop formation in evolving transport networks, S. Żukowski, A. J. M. Cornelissen, F. Osselin, S. Douady, P. Szymczak, PNAS 121 (29), e2401200121 (2024). Materials

References: The thin-finger growth algorithm used in this package was based on an earlier code described in the paper Bifurcation dynamics of natural drainage networks (A. Petroff, O. Devauchelle, H. Seybold, and D. H. Rothman. Philos. Trans. Royal Soc. A 371, 20120365, 2013)