Skip to content

greatlse/ecell4

 
 

Repository files navigation

E-Cell System version 4

Build Status Gitter

What is E-Cell System?

E-Cell System, a software platform for modeling, simulation and analysis of complex, heterogeneous and multi-scale systems like the cell.

Installation

Windows installation

Requirements

Please use 32bit Python, even if you use 64bit Windows. We don't support 64bit Python

Please add C:\Python27, C:\Python27\Scripts and C:\Program Files (x86)\HDF_Group\HDF5\1.8.14\bin to your PATH enviromental variable.

And run following command with command prompt.

pip install https://github.com/ecell/ecell4/releases/download/4.0.0-beta2/ecell4-4.0.0b2-cp27-none-win32.whl

Jupyter for Windows

We recommend you run E-Cell4 models from Jupyter notebook. Below is Jupyter notebook(and matplotlib) installation for Windows.

matplotlib depends on numpy. It takes some time to build numpy, please be patient.

Mac OS X installation

ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
brew tap ecell/ecell4
brew install ecell4 --HEAD

Jupyter for Mac

We recommend you run E-Cell4 models from Jupyter notebook. Below is Jupyter notebook(and matplotlib) installation for Mac.

sudo python get-pip.py
sudo pip install -U matplotlib
sudo pip install -U jupyter

Ubuntu Linux Vivid Vervet installation

Python2 series

# dependent packages
$ sudo apt-get install cmake libgsl0-dev libboost-regex-dev libhdf5-dev cython

$ wget https://github.com/ecell/ecell4/archive/master.zip   
$ unzip master.zip
$ cd ecell4-master
# By default install.sh tries to install E-Cell4 into /usr/local, in this case you need to use sudo.
# In the following command, we install E-Cell4 into $HOME/ecell4. In this case you do NOT need to use sudo.
$ PREFIX=$HOME/ecell4 ./install.sh py2

Python3 series

# dependent packages
$ sudo apt-get install cmake libgsl0-dev libboost-regex-dev libhdf5-dev cython3

$ wget https://github.com/ecell/ecell4/archive/master.zip   
$ unzip master.zip
$ cd ecell4-master
# By default install.sh tries to install E-Cell4 into /usr/local, in this case you need to use sudo.
# In the following command, we install E-Cell4 into $HOME/ecell4. In this case you do NOT need to use sudo.
$ PREFIX=$HOME/ecell4 ./install.sh py3

Ubuntu Linux Trusty Tahr installation

# dependent packages
$ sudo apt-get install cmake libgsl0-dev libboost-regex-dev libhdf5-dev libatlas-base-dev python-dev python-pip
$ sudo pip install cython

$ wget https://github.com/ecell/ecell4/archive/master.zip   
$ unzip master.zip
$ cd ecell4-master
# By default install.sh tries to install E-Cell4 into /usr/local, in this case you need to use sudo.
# In the following command, we install E-Cell4 into $HOME/ecell4. In this case you do NOT need to use sudo.
$ PREFIX=$HOME/ecell4 PYTHONPATH=/path/to/lib/python2.7/site-packages ./install.sh py2

Running E-Cell4

How to run Python for E-Cell4 (Windows)

  1. run command prompt
  2. run Python
python

How to run Python for E-Cell4 (Mac)

  1. run terminal
  2. run Python with PYTHONPATH
PYTHONPATH=/usr/local/Cellar/ecell4/HEAD/libexec/lib/python2.7/site-packages python

How to run Python for E-Cell4 (Ubuntu)

If you set PREFIX to $HOME/ecell4, run Python with

LD_LIBRARY_PATH=$HOME/ecell4/lib:$LD_LIBRARY_PATH PYTHONPATH=$HOME/ecell4/lib/python2.7/site-packages python

in case with Python3

LD_LIBRARY_PATH=$HOME/ecell4/lib:$LD_LIBRARY_PATH PYTHONPATH=$HOME/ecell4/lib/python3.4/site-packages python3

Simple examples

Here are two extremely simple examples, See http://ecell4.readthedocs.org/en/latest/tutorials/ for more details on running E-Cell4.

Python 2.7.6 (default, Mar 22 2014, 22:59:56)
[GCC 4.8.2] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> from ecell4 import *
>>> sp = Species("B.A.C")
>>> print(sp.serial())
B.A.C
>>> print(unique_serial(sp))
A.B.C

A reversible binding reaction

%matplotlib inline
import numpy
from ecell4 import *

with reaction_rules():
    A + B == C | (0.01, 0.3)

run_simulation(
    numpy.linspace(0, 10, 100), {'A': 60, 'B': 60}, solver='ode')

png

Dockerized E-Cell4 Jupyter notebooks

If you use docker, you can easily try E-Cell4. You can pull E-Cell4 container with docker pull ecell/ecell4

For Windows and Mac

  1. Install Docker Toolbox
  2. Run Kitematic
  3. Search with ecell4, and create ecell4 container

png

  1. Open the ACCESS URL in IP & PORTS with your web browser

png

For Linux

$ sudo docker pull ecell/ecell4
$ sudo docker run -d -p 443:8888 ecell/ecell4

You'll now be able to E-Cell4 notebooks at https://THE_IP_RUNNING_DOCKER:443

About

A multi-algorithm, multi-timescale biochemical simulation environment

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C++ 45.9%
  • Mathematica 30.8%
  • Python 21.2%
  • EmberScript 0.7%
  • CMake 0.4%
  • TeX 0.4%
  • Other 0.6%