Simulation & Results¶
Functions and classes for running simulations and working with results.
simulate¶
handler: python options: show_source: false show_signature_annotations: true
Result¶
get_time_axis(time_index: Optional[int] = None) -> float | list[float]
¶
Get x-axis data of times specified by time_index.
handler: python options: show_source: false show_signature_annotations: true members_order: source
Plotter¶
get_3d_slice_animation(channel_id: str, interval: int = 200) -> animation.FuncAnimation
¶
Animate the 3D scatter plot over time.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
channel_id
|
str
|
The label of the channel to visualize. |
required |
interval
|
int
|
Time interval between frames in milliseconds. |
200
|
get_image_animation(image_index: int, interval: int = 200) -> animation.FuncAnimation
¶
Animate the fluorescence image over time.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
image_index
|
int
|
The index of the image to visualize. |
required |
interval
|
int
|
Time interval between frames in milliseconds. |
200
|
handler: python options: show_source: false show_signature_annotations: true members_order: source
VtkData¶
handler: python options: show_source: false show_signature_annotations: true members_order: source
Field¶
handler: python options: show_source: false show_signature_annotations: true members_order: source
SBML Spatial Simulation¶
SbmlSpatialModel¶
Spatial extension of libsbml.Model. All class methods are inherited from libsbml.Model: see libsbml documentation for more details.
This class is constructed with one of 3 entrypoints: either the filepath to a valid SBMLSpatial model, OR level, version, model_id, OR model_id
handler: python options: show_source: false show_signature_annotations: true members_order: source
SbmlSpatialSimulation¶
handler: python options: show_source: false show_signature_annotations: true members_order: source