Skip to main content

A Python3.6+ CRN Simulator

Project description

# Python CRN
A CRN simulator based on
[David Soloveichik's Mathematica CRN Simulator](
http://users.ece.utexas.edu/~soloveichik/crnsimulator.html)

## Version & Promises
Currently this is in a pre-alpha state, but already has some reasonable
features. No guarantees are made for backward-compatibility. That is, some
of the API calls might change, some of the reaction literals syntax might
change, etc.

## Dependencies
The package is written for Python 3.6+ and definitely won't work on an older
Python version.

The current list of dependencies are
```
numpy
scipy
sympy
stochpy
```

## Examples
A simple example of creating a crn, simulating it, and plotting it, is given
here. An explanation of this code in detail can be found in
`crn/examples/basic_example.py`.

```python
from crn import *

a, a1, a2, b, c, t, z = species("A A1 A2 B C T Z")

sys = CRN(
a >> a1 + a2,
a1 + b >> t,
c >> z,
(a2 >> z).k(2.5),
z + t >> 0)

sys.simulate({a: 2.5, b: 2.0}, t=5).plot("sim.png", title="Example Simulation")
```

More examples will be added soon in the `crn/examples/` folder.


## Installation
Install using `pip` or `pip3` depending on your setup.
```
pip3 install crn
```

This is broken at the moment since
[StochPy](https://github.com/SystemsBioinformatics/stochpy) is not 100%
Python 3 ready. I'll write an install script to modify some of the StochPy
files to fix for this while I wait for the Pull Request to go through.

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

crn-0.1.0a1.tar.gz (8.3 kB view hashes)

Uploaded Source

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