finesse.parameter.parameterproperty

Overview

class finesse.parameter.parameterproperty(fget, fset, flocked, doc=None)

Bases: property

Descriptor class for declaring a simulation parameter. A simulation parameter is one that can be changed during a simulation and affect the resulting outputs. The idea is that output dependant variables should be marked as having been changed or will be changed during a simulation run. This allows us to then optimise parts of the model, as we can determine what will or will not be changing. This descriptor is paired with the :class:Parameter.

Parameters can then be superficially locked once a model has been built so accidentally changing some parameter that isn’t expected to change can flag a warning.

Methods

parameterproperty.__init__(self, fget, fset, ...)
parameterproperty.getter(self, fget)
parameterproperty.setter(self, fset)