sme.open_example_model

sme.open_example_model(name: str = 'very-simple-model') → sme::Model

opens a built in example spatial model

The model name can optionally be specified to one of the following built in models:

• “ABtoC”

• “brusselator-model”

• “circadian-clock”

• “gray-scott”

• “liver-simplified”

• “liver-cells”

• “single-compartment-diffusion”

• “very-simple-model”

If the name is not specified the the default example model is “very-simple-model”.

Parameters:

name (str, optional) – name of the example model to open, default: “very-simple-model”

Returns:

the example spatial model

Return type:

Model

Examples

>>> import sme
>>> model = sme.open_example_model()
>>> repr(model)
"<sme.Model named 'Very Simple Model'>"
>>> print(model)
<sme.Model>
  - name: 'Very Simple Model'
  - compartments:
     - Outside
     - Cell
     - Nucleus
  - membranes:
     - Outside <-> Cell
     - Cell <-> Nucleus