transition

All classes required to define a transition that is inserted into the ode model

class pygom.model.transition.Transition(origin, equation, transition_type='ODE', destination=None, ID=None, name=None)

This class carries the information for transitions defined for an ode, which includes the ode itself, a birth death process where only one state is involved and also a transition between two states

Parameters:

origin: str

Origin state.

equation: str

Equation defining the transition

transition_type: enum or str, optional

of type TransitionType or one of (‘ODE’, ‘T’, ‘B’, ‘D’) defaults to ‘ODE’

destination: str, optional

Destination State. If the transition is not between state, such as a birth or death process, then this is is not required. If it is stated as a birth, death or an ode then it throws an error

destination

Return the destination state

Returns:

string

The destination state

equation

Return the transition _equation

Returns:

string

The transition _equation

is_between_state()

Return whether it is a transition between two state

Returns:

bool

True if it is a transition between two state False if it is only related to the origin state

origin

Return the origin state

Returns:

string

The origin state

transition_type

Return the type of transition

Returns:

transition_type

One of the four type available from transition_type

class pygom.model.transition.TransitionType

This is an Enum describing the four feasible type of transitions use to define the ode model BaseOdeModel

The following four types of transitions are available.

B = Birth process

D = Death process

T = Transition between states

ODE = ODE _equation