DynamicSpace.refs#

property DynamicSpace.refs#

Read-only mapping of reference names to their values.

Returns a dictionary-like view of all references accessible in this space, including:

  • References defined in this space (for UserSpace)

  • References inherited from base spaces

  • Global references defined at the model level

References provide access to external data, modules, or other modelx objects from within cell formulas.

Returns:

Dictionary-like mapping of names to reference values

Return type:

RefView

Example

>>> space.refs
{'data': <DataFrame...>,
 'discount_rate': 0.05}

>>> # Access a reference value
>>> space.refs['discount_rate']
0.05

>>> # Within formulas, references are accessed by name
>>> @mx.defcells
... def present_value(t):
...     return cashflow(t) / (1 + discount_rate) ** t

See also