Skip to content

Parameter

Parameter

Bases: UUIDBaseNode

Definition

A parameter is an input value to an algorithm.

Difference between Parameter and Condition

For typical computations, the difference between parameter and condition lies in whether it changes the thermodynamic state of the simulated system: Variables that are part of defining a thermodynamic state should be defined as a condition in a parent node.

Therefore, number and volume need to be listed as conditions while boundaries and origin are parameters of ensemble size

Can Be Added To:
Available sub-objects:
  • None
Attributes
attribute type example description required vocab
key str key for identifier True True
value Any value True
unit str unit for parameter
JSON Representation
{
   "key":"update_frequency",
   "node":["Parameter"],
   "unit":"1/second",
   "value":1000.0
   "uid":"_:6af3b3aa-1dbc-4ce7-be8b-1896b375001c",
   "uuid":"6af3b3aa-1dbc-4ce7-be8b-1896b375001c",
}
Source code in src/cript/nodes/subobjects/parameter.py 
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
class Parameter(UUIDBaseNode):
    """
    ## Definition

    A [parameter](https://pubs.acs.org/doi/suppl/10.1021/acscentsci.3c00011/suppl_file/oc3c00011_si_001.pdf#page=25)
    is an input value to an algorithm.

    ??? note "Difference between `Parameter` and `Condition`"
        For typical computations, the difference between
        parameter and condition lies in whether it changes the thermodynamic state of the simulated
        system: Variables that are part of defining a thermodynamic state should be defined as a condition
        in a parent node.

        Therefore, `number` and `volume` need to be listed as conditions while
        `boundaries` and `origin` are parameters of ensemble size

    ---
    ## Can Be Added To:
    * [Algorithm sub-object](../algorithm)

    ## Available sub-objects:
    * None

    ---

    ## Attributes

    | attribute | type | example | description        | required | vocab |
    |-----------|------|---------|--------------------|----------|-------|
    | key       | str  |         | key for identifier | True     | True  |
    | value     | Any  |         | value              | True     |       |
    | unit      | str  |         | unit for parameter |          |       |


    ## JSON Representation
    ```json
    {
       "key":"update_frequency",
       "node":["Parameter"],
       "unit":"1/second",
       "value":1000.0
       "uid":"_:6af3b3aa-1dbc-4ce7-be8b-1896b375001c",
       "uuid":"6af3b3aa-1dbc-4ce7-be8b-1896b375001c",
    }
    ```
    """

    @dataclass(frozen=True)
    class JsonAttributes(UUIDBaseNode.JsonAttributes):
        key: str = ""
        value: Optional[Number] = None
        # We explicitly allow None for unit here (instead of empty str),
        # this presents number without physical unit, like counting
        # particles or dimensionless numbers.
        unit: Union[str, None] = None

    _json_attrs: JsonAttributes = JsonAttributes()

    # Note that the key word args are ignored.
    # They are just here, such that we can feed more kwargs in that we get from the back end.
    @beartype
    def __init__(self, key: str, value: Number, unit: Optional[str] = None, **kwargs):
        """
        create new Parameter sub-object

        Parameters
        ----------
        key : str
            Parameter key must come from [CRIPT Controlled Vocabulary](https://app.criptapp.org/vocab/parameter_key)
        value : Union[int, float]
            Parameter value
        unit : Union[str, None], optional
            Parameter unit, by default None

        Examples
        --------
        >>> import cript
        >>> my_parameter = cript.Parameter("update_frequency", 1000.0, "1/second")

        Returns
        -------
        None
            create Parameter sub-object
        """
        super().__init__(**kwargs)
        new_json_attrs = replace(self._json_attrs, key=key, value=value, unit=unit)
        self._update_json_attrs_if_valid(new_json_attrs)

    @classmethod
    def _from_json(cls, json_dict: dict):
        # TODO: remove this temporary fix, once back end is working correctly
        try:
            json_dict["value"] = float(json_dict["value"])
        except KeyError:
            pass
        return super(Parameter, cls)._from_json(json_dict)

    @property
    @beartype
    def key(self) -> str:
        """
        Parameter key must come from the [CRIPT Controlled Vocabulary](https://app.criptapp.org/vocab/parameter_key)

        Examples
        --------
        >>> import cript
        >>> my_parameter = cript.Parameter("update_frequency", 1000.0, "1/second")
        >>> my_parameter.key = "damping_time"

        Returns
        -------
        str
            parameter key
        """
        return self._json_attrs.key

    @key.setter
    @beartype
    def key(self, new_key: str) -> None:
        """
        set new key for the Parameter sub-object

        Parameters
        ----------
        new_key : str
            new Parameter key

        Returns
        -------
        None
        """
        new_attrs = replace(self._json_attrs, key=new_key)
        self._update_json_attrs_if_valid(new_attrs)

    @property
    @beartype
    def value(self) -> Optional[Number]:
        """
        Parameter value

        Examples
        --------
        >>> import cript
        >>> my_parameter = cript.Parameter("update_frequency", 1000.0, "1/second")
        >>> my_parameter.value = 1

        Returns
        -------
        Union[int, float, str]
            parameter value
        """
        return self._json_attrs.value

    @value.setter
    @beartype
    def value(self, new_value: Number) -> None:
        """
        set the Parameter value

        Parameters
        ----------
        new_value : Union[int, float, str]
            new parameter value

        Returns
        -------
        None
        """
        new_attrs = replace(self._json_attrs, value=new_value)
        self._update_json_attrs_if_valid(new_attrs)

    @property
    @beartype
    def unit(self) -> Union[str, None]:
        """
        Parameter unit

        Examples
        --------
        >>> import cript
        >>> my_parameter = cript.Parameter("update_frequency", 1000.0, "1/second")
        >>> my_parameter.unit = "gram"

        Returns
        -------
        str
            parameter unit
        """
        return self._json_attrs.unit

    @unit.setter
    @beartype
    def unit(self, new_unit: str) -> None:
        """
        set the unit attribute for the Parameter sub-object

        Parameters
        ----------
        new_unit : str
            new Parameter unit

        Returns
        -------
        None
        """
        new_attrs = replace(self._json_attrs, unit=new_unit)
        self._update_json_attrs_if_valid(new_attrs)

__init__(key, value, unit=None, **kwargs)

create new Parameter sub-object

Parameters:

Name Type Description Default
key str

Parameter key must come from CRIPT Controlled Vocabulary

 required
value Union[int, float]

Parameter value

 required
unit Union[str, None]

Parameter unit, by default None

 None

Examples:

>>> import cript
>>> my_parameter = cript.Parameter("update_frequency", 1000.0, "1/second")

Returns:

Type Description
None

create Parameter sub-object
Source code in src/cript/nodes/subobjects/parameter.py 
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
@beartype
def __init__(self, key: str, value: Number, unit: Optional[str] = None, **kwargs):
    """
    create new Parameter sub-object

    Parameters
    ----------
    key : str
        Parameter key must come from [CRIPT Controlled Vocabulary](https://app.criptapp.org/vocab/parameter_key)
    value : Union[int, float]
        Parameter value
    unit : Union[str, None], optional
        Parameter unit, by default None

    Examples
    --------
    >>> import cript
    >>> my_parameter = cript.Parameter("update_frequency", 1000.0, "1/second")

    Returns
    -------
    None
        create Parameter sub-object
    """
    super().__init__(**kwargs)
    new_json_attrs = replace(self._json_attrs, key=key, value=value, unit=unit)
    self._update_json_attrs_if_valid(new_json_attrs)

key(new_key)

set new key for the Parameter sub-object

Parameters:

Name Type Description Default
new_key str

new Parameter key

 required

Returns:

Type Description
None
Source code in src/cript/nodes/subobjects/parameter.py 
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
@key.setter
@beartype
def key(self, new_key: str) -> None:
    """
    set new key for the Parameter sub-object

    Parameters
    ----------
    new_key : str
        new Parameter key

    Returns
    -------
    None
    """
    new_attrs = replace(self._json_attrs, key=new_key)
    self._update_json_attrs_if_valid(new_attrs)

unit(new_unit)

set the unit attribute for the Parameter sub-object

Parameters:

Name Type Description Default
new_unit str

new Parameter unit

 required

Returns:

Type Description
None
Source code in src/cript/nodes/subobjects/parameter.py 
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
@unit.setter
@beartype
def unit(self, new_unit: str) -> None:
    """
    set the unit attribute for the Parameter sub-object

    Parameters
    ----------
    new_unit : str
        new Parameter unit

    Returns
    -------
    None
    """
    new_attrs = replace(self._json_attrs, unit=new_unit)
    self._update_json_attrs_if_valid(new_attrs)

value(new_value)

set the Parameter value

Parameters:

Name Type Description Default
new_value Union[int, float, str]

new parameter value

 required

Returns:

Type Description
None
Source code in src/cript/nodes/subobjects/parameter.py 
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
@value.setter
@beartype
def value(self, new_value: Number) -> None:
    """
    set the Parameter value

    Parameters
    ----------
    new_value : Union[int, float, str]
        new parameter value

    Returns
    -------
    None
    """
    new_attrs = replace(self._json_attrs, value=new_value)
    self._update_json_attrs_if_valid(new_attrs)