Dynamical Systems Modeling Framework
PyRates is a framework for dynamical systems modeling, developed by Richard Gast and Daniel Rose. It is an open-source project that everyone is welcome to contribute to.
- implement models via a frontend of your choice: YAML or Python
- create basic mathematical building blocks (i.e. differential equations and algebraic equations) and use them to define a networks of nodes connected by edges
- create hierarchical networks by connecting networks via edges
- choose from a number of different backends
NumPybackend for dynamical systems modeling on CPUs via Python
PyTorchbackends for parameter optimization via gradient descent and dynamical systems modeling on GPUs
Juliabackend for dynamical system modeling in Julia, via tools such as
Fortranbackend for dynamical systems modeling via Fortran 90 and interfacing the parameter continuation software Auto-07p
- Other features:
- perform quick numerical simulations via a single function call
- choose between different numerical solvers
- perform parameter sweeps over multiple parameters at once
- generate backend-specific run functions that evaluate the vector field of your dynamical system
- Implement dynamic edge equations that include scalar dealys or delay distributions (delay distributions are automatically translated into gamma-kernel convolutions)
- choose from various pre-implemented dynamical systems that can be directly used for simulations or integrated into custom models
Stable release (PyPI)
PyRates can be installed via the
pip command. We recommend to use
Anaconda to create a new python environment with Python >= 3.6 and then simply run the following line from a terminal with the environment being activated:
pip install pyrates
You can install optional (non-default) packages by specifying one or more options in brackets, e.g.:
pip install pyrates[backends]
Available options are
all at the moment.
The latter includes all optional packages.
Furthermore, the option
tests includes all packages necessary to run tests found in the github repository.
Development version (github)
Alternatively, it is possible to clone this repository and run one of the following lines from the directory in which the repository was cloned:
python setup.py install
pip install '.[<options>]'
Finally, a singularity container of the most recent version of this software can be found here. This container provides a stand-alone version of PyRates including all necessary Python tools to be run, independent of local operating systems. To be able to use this container, you need to install Singularity on your local machine first. Follow these instructions to install singularity and run scripts inside the PyRates container.
For a full API of PyRates, see https://pyrates.readthedocs.io/en/latest/. For examplary simulations and model configurations, please have a look at the jupyter notebooks provided in the documenation folder.
If you use this framework, please cite: Gast, R., Rose, D., Salomon, C., Möller, H. E., Weiskopf, N., & Knösche, T. R. (2019). PyRates-A Python framework for rate-based neural simulations. PloS one, 14(12), e0225900.
If you have questions, problems or suggestions regarding PyRates, please contact Richard Gast.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.