py_compart_model package

Submodules

py_compart_model.main module

class py_compart_model.main.ArithmaticBase

Bases: object

get_equ(obj)

Get string information for object.

Return type

float

get_value(obj)

Get value of object regardless of Compartment or Param.

Return type

float

class py_compart_model.main.Compartment(name, index, value=None)

Bases: py_compart_model.main.ArithmaticBase

set_init(value)

Set a value.

Return type

None

class py_compart_model.main.Model

Bases: object

C(name, value=None)

Set Compartment for Compartment model.

Return type

Compartment

create_function(params, verbose=True)

Create function string with parameters information.

Return type

None

get_args_from_params()

Get arguments from parameters. It is noted that self.params are ordered by index.

get_compartment_inits()

Sort by index of components of compartment model and return its initial values.

solve(t_span, raw=False, **kargs)

Parameters

• raw (bool) – if True, return results from solve_ivp.

• kargs – passed to solve_ivp implemented in scipy.

Return type

PyCompartModelResult

class py_compart_model.main.Param(name, value=None)

Bases: py_compart_model.main.ArithmaticBase

set_value(value)

Set a value.

Return type

None

class py_compart_model.main.PyCompartModelResult(model, res)

Bases: object

reverse_res_to_compartments(res)

Reverse results of y returned from Model.solve method into components results.

Note

If the result name is conflicted with default name of the results of solve_ivp, Raise Error.

Return type

OdeResult

summary()

py_compart_model.main.plot_over_time(ode_res, comparts=None, ax=None)

Plot results of a solver against time,

Module contents