stimator.model.Model

class stimator.model.Model(title='')

The class that holds the description of a kinetic model.

This class holds several members describing the data associated with the description of a kinetic model.

A model is comprised of:

  • reactions
  • parameters
  • initial values
  • transformations
  • external variables

Attributes

reactions (_Collection_Accessor) The processes in the model.
transformations (_Collection_Accessor) The transformations in the model.
parameters (_Parameters_Accessor) The parameters in the model.
varnames (list of str) The names of the variables defined in the model. This list should be treated as read-only and is internally refreshed everytime a reaction is added or changed.
extvariables (list of str) The names of the external variables defined in the model. This list should be treated as read-only and is internally refreshed everytime a reaction or parameter is added or changed.
init (_init_Accessor) The initial state of the model.
with_bounds (_With_Bounds_Accessor) Iterates through the parameters in the model for which Bounds were assigned.

Methods

checkRates()
copy([new_title])
estimate([timecourses])
get_bounds(name)
get_init([names, default])
getp(name)
info([no_check])
reset_bounds(name)
reset_init()
scan(plan, **kwargs)
set_bounds(name, value)
set_init(*p, **pdict)
set_reaction(name, stoichiometry[, rate, pars]) Insert or modify a reaction in the model.
set_transformation(name[, rate, pars])
set_uncertain(uncertainparameters)
set_variable_dXdt(name[, rate, pars])
setp(name, value)
solve(**kwargs)
update(*p, **pdict)
set_reaction(name, stoichiometry, rate=0.0, pars=None)

Insert or modify a reaction in the model.

Parameters:

name : str

The name of the reaction.

stoichiometry : str

The stoichiometry of the reaction.

rate : str or int or float.

The kinetic function of the reaction. If it is a number, a mass-action rate will be assumed.

pars : dict of iterable of (name, value) pairs

The ‘local’ parameters of the reaction.