Python InterfaceΒΆ

A Python interface is available, which can be installed from PyPI with

pip install sme

Note

If your python version or platform is not supported, please submit a feature request

Once it is installed, you should be able to import the sme module and load the built-in example model:

  $ python
  Python 3.8.5 (default, Aug 13 2020, 08:28:54)
  [GCC 10.0.1 20200416 (experimental) [master revision 3c3f12e2a76:dcee354ce56:44 on linux
  Type "help", "copyright", "credits" or "license" for more information.
  >>> import sme
  >>> model = sme.open_example_model()
  >>> print(model)
  <sme.Model>
    - name: 'Very Simple Model'
    - compartments:
       - Outside
       - Cell
       - Nucleus

Tip

There is an online colab notebook where you can try it out in your browser without installing anything on your computer.

As shown in the getting started notebook, sme allows you to import an existing model, change the value of parameters in the model, simulate the model and produce images of the species concentrations from the simulation. To get help on an object, its methods and properties, use the help function, e.g. help(sme.Model).