reno.components.Flow

class reno.components.Flow(eq=None, label=None, doc=None, min=None, max=None, dim=1, group='', dtype=None)

Bases: TrackedReference

A flow is a rate, a movement of some material/thing/quantity per some unit of time.

Flow equations probably reference stocks, moving stuff from one stock to another etc. Flows are what stocks are defined in terms of (in_flows and out_flows.)

https://insightmaker.com/docs/flows https://en.wikipedia.org/wiki/Stock_and_flow

Methods

__init__([eq, label, doc, min, max, dim, ...])
clip(min, max)
debug_equation(t[, sample])
display()	Display an ipython markdown with the equation latex.
equal(obj)
equation(**kwargs)	Return the full latex string representation for the entire equation, not just the right hand side.
eval([t, save, compute_mask, force])	Compute the equation for the given timestep.
find_refs_of_type(search_type[, already_checked])	Actually recursive as opposed to seek_refs, returns a list of all equation parts matching passed type.
from_dict(data, refs)	Deserialize reference and parse data from dictionary previously saved from to_dict().
get_shape()	For now this is returning an integer because we only allow a single additional dimension.
get_type()	Similar to shape, this gets computed recursively, used to automatically determine if the value needs to be initialized with a certain numpy type.
history(index_eq)	Get a reference to a previous value of this reference.
initial_vals()	Variables can be set to distributions, so the inital vals in that case will be a population sampled from the eq distribution.
is_static()	Convenience shortcut for reno.utils.is_static() - True if this equation doesn't rely on any dynamic values (thus constant), False if it does.
latex(**kwargs)	Get the string representation for referring to this flow, italized and as a function of t to better represent that this should be a rate?
max_refs()	Get any references found in the max constraint equation.
min_refs()	Get any references found in the min constraint equation.
not_equal(obj)
populate(n, steps)	Initialize the matrix of values with size n x steps.
pt(**refs)	Get a pytensor graph representing this piece of an equation.
pt_str(**refs)	Construct a string containing relevant pytensor code for this piece of the equation.
qual_name([dot])	Get a string with both the model and the reference name if this model is a submodel of something else.
resolve_init_array(obj_or_eq)	Convert a number or scalar/distribution into correct starting array.
seek_refs()	Immediate refs only, depth=1.
series_max()
series_min()
sum([axis])
to_dict()	Serialize class into a dictionary for saving to file.

Attributes

dtype	The type of each underlying value.
shape	The size of the data dimension, 1 by default.
timeseries	Get a timeseries view of the data (includes all historical data across all timesteps.)
model	Keep a reference to container model, makes it easier to compare refs across multiple models.
init	Initial value/equation for initial value for stock/flow/var at t=0
dim	Size of an optional extra dimension, allowing a given reference to describe a vector of values at every timestep.
implicit	Implicit components (normally created as subcomponents of more advanced operations) don't show up in diagrams, latex, or output JSON, since they are created by operations.
computed_mask	Follows same shape as value (up through first two dimensions), set of booleans indicating which values have already been evaluated and saved.
label	Label is what's used in any visual representation (e.g. allows spaces where name does not.).
doc	A docstring to explain/describe the reference.

Parameters:

• eq (EquationPart)

• label (str)

• doc (str)

• min (EquationPart)

• max (EquationPart)

• dim (int)

• group (str)

• dtype (type)

__annotations__ = {}

__module__ = 'reno.components'

__setattr__(name, value)

Implement setattr(self, name, value).

debug_equation(t, sample=0, **kwargs)

display()

Display an ipython markdown with the equation latex.

equation(**kwargs)

Return the full latex string representation for the entire equation, not just the right hand side.

Return type:

str

initial_vals()

Variables can be set to distributions, so the inital vals in that case will be a population sampled from the eq distribution.

latex(**kwargs)

Get the string representation for referring to this flow, italized and as a function of t to better represent that this should be a rate?

Return type:

str