README

README.md

@@ -0,0 +1,30 @@
+# boolSim-python
+
+This Python module is an interface to the software tools boolSim
+(https://www.vital-it.ch/research/software/boolSim) for the computation of
+attractors in synchronous and asynchronous Boolean Networks.
+
+## Installation
+
+### CoLoMoTo Notebook environment
+
+`boolSim-python` is distributed as part of the [CoLoMoTo docker](http://colomoto.org/notebook).
+
+### Using conda
+```
+conda install -c colomoto boolsim-python
+```
+
+### Using pip
+
+```
+pip install boolsim
+python -m boolsim_setup
+```
+
+## Documentation
+
+Documentation is available at https://boolsim-python.readthedocs.io.
+
+Examples can be found at:
+* https://nbviewer.jupyter.org/github/colomoto/boolSim-python/tree/main/examples/.