Model
heavylight.Model
¤
df
property
¤
return a pandas dataframe of all single parameter columns parameterised with t
__init__(*, do_run=None, proj_len: int = 0, **kwargs)
¤
Base Class to subclass for user models.
When the model is instanced it is run to proj_len, if non-zero.
Parameters¤
- proj_len: length of projection to run
All variables/methods in user models should be lower case, using underscore as spaces.
Class level methods
RunModel(proj_len): Run the model to proj_len.
Special user methods
BeforeRun(self): If this is specified in the user model it called before the projection starts, e.g. to set up some specific variables
AfterRun(self): user method, called after Run is completed, e.g. can use to calculate NPVs of variables
methods/variables to avoid:
methods/variables starting with an underscore _ are treated as internal. You may break functionality if you create your own.