Scale Intelligence■ Docs
Docs / The model / ModelFlow

ModelFlow.

One flow of a systems model between two stocks, its rate a driver tree the one evaluator computes each step

Figure 1ModelFlowspecified
MODELFLOWvalue at none scopenametextfrom_stocktextto_stocktextthe units that move per step, as a tree over driversrateDriverNodethe roles that hand the unit onroles[RoleAroundADecision]the calculation shape the flow's money follows, where it carries moneyshapeCalculationShapeoptionalthe predicate, by name, that selects the units the flow movesselectstextoptionalthe delay before a moved unit countsdelaydurationoptionalDRIVERNODEthrough rateROLEAROUNDADECISIONthrough rolesCALCULATIONSHAPEthrough shape
ModelFlow is a value at none scope. The drawing shows its fields and the objects that they point at.
kind
value
scope
none
key
none
store
none
family
market

Fields#

fieldtyperequirednote
nametextyes
from_stocktextyes
to_stocktextyes
rateDriverNodeyesthe units that move per step, as a tree over drivers
rolesRoleAroundADecisionyesthe roles that hand the unit on
shapeCalculationShapenothe calculation shape the flow’s money follows, where it carries money
selectstextnothe predicate, by name, that selects the units the flow moves
delaydurationnothe delay before a moved unit counts

Routes that use it#

No route takes or returns ModelFlow directly. The record holds it, and the objects that point at it reach it.