Skip to content

Quantity

Quantity

Bases: UUIDBaseNode

Definition

The Quantity sub-objects are the amount of material involved in a process

Can Be Added To:
Available sub-objects
  • None
Attributes
attribute type example description required vocab
key str mass type of quantity True True
value Any 1.23 amount of material True
unit str gram unit for quantity True
uncertainty Number 0.1 uncertainty of value
uncertainty_type str std type of uncertainty True
JSON Representation
{
 "node":["Quantity"],
 "key":"mass",
 "value":11.2
 "uncertainty":0.2,
 "uncertainty_type":"stdev",
 "unit":"kg",
 "uid":"_:c95ee781-923b-4699-ba3b-923ce186ac5d",
 "uuid":"c95ee781-923b-4699-ba3b-923ce186ac5d",
}
Source code in src/cript/nodes/subobjects/quantity.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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
class Quantity(UUIDBaseNode):
    """
    ## Definition
    The [Quantity](https://pubs.acs.org/doi/suppl/10.1021/acscentsci.3c00011/suppl_file/oc3c00011_si_001.pdf#page=22)
    sub-objects are the amount of material involved in a process

    ---

    ## Can Be Added To:
    * [Ingredient](../ingredient)

    ## Available sub-objects
    * None

    ----

    ## Attributes

    | attribute        | type    | example | description          | required | vocab |
    |------------------|---------|---------|----------------------|----------|-------|
    | key              | str     | mass    | type of quantity     | True     | True  |
    | value            | Any     | 1.23    | amount of material   | True     |       |
    | unit             | str     | gram    | unit for quantity    | True     |       |
    | uncertainty      | Number  | 0.1     | uncertainty of value |          |       |
    | uncertainty_type | str     | std     | type of uncertainty  |          | True  |




    ## JSON Representation
    ```json
    {
     "node":["Quantity"],
     "key":"mass",
     "value":11.2
     "uncertainty":0.2,
     "uncertainty_type":"stdev",
     "unit":"kg",
     "uid":"_:c95ee781-923b-4699-ba3b-923ce186ac5d",
     "uuid":"c95ee781-923b-4699-ba3b-923ce186ac5d",
    }
    ```
    """

    @dataclass(frozen=True)
    class JsonAttributes(UUIDBaseNode.JsonAttributes):
        key: str = ""
        value: Union[Number, str, None] = None
        unit: str = ""
        uncertainty: Optional[Number] = None
        uncertainty_type: str = ""

    _json_attrs: JsonAttributes = JsonAttributes()

    @beartype
    def __init__(self, key: str, value: Number, unit: str, uncertainty: Optional[Number] = None, uncertainty_type: str = "", **kwargs):
        """
        create Quantity sub-object

        Parameters
        ----------
        key : str
            type of quantity. Quantity key must come from
            [CRIPT Controlled Vocabulary](https://app.criptapp.org/vocab/quantity_key)
        value : Number
            amount of material
        unit : str
            unit for quantity
        uncertainty : Union[Number, None], optional
            uncertainty of value, by default None
        uncertainty_type : str, optional
            type of uncertainty. Quantity uncertainty type must come from
            [CRIPT Controlled Vocabulary](https://app.criptapp.org/vocab/uncertainty_type), by default ""

        Examples
        --------
        >>> import cript
        >>> my_quantity = cript.Quantity(
        ...     key="mass", value=11.2, unit="kg", uncertainty=0.2, uncertainty_type="stdev"
        ... )

        Returns
        -------
        None
            create Quantity sub-object
        """
        super().__init__(**kwargs)
        new_json_attrs = replace(self._json_attrs, key=key, value=value, unit=unit, uncertainty=uncertainty, uncertainty_type=uncertainty_type)
        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
        for key in ["value", "uncertainty"]:
            try:
                json_dict[key] = float(json_dict[key])
            except KeyError:
                pass
        return super(Quantity, cls)._from_json(json_dict)

    @beartype
    def set_key_unit(self, new_key: str, new_unit: str) -> None:
        """
        set the Quantity key and unit attributes

        Quantity key must come from [CRIPT Controlled Vocabulary](https://app.criptapp.org/vocab/quantity_key)

        Examples
        --------
        >>> import cript
        >>> my_quantity = cript.Quantity(
        ...     key="mass", value=11.2, unit="kg", uncertainty=0.2, uncertainty_type="stdev"
        ... )
        >>> my_quantity.set_key_unit(new_key="mass", new_unit="kg")

        Parameters
        ----------
        new_key : str
            new Quantity key. Quantity key must come from
            [CRIPT Controlled Vocabulary](https://app.criptapp.org/vocab/quantity_key)
        new_unit : str
            new unit

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

    @property
    @beartype
    def key(self) -> str:
        """
        get the Quantity sub-object key attribute

        [Quantity type](https://app.criptapp.org/vocab/quantity_key) must come from CRIPT controlled vocabulary

        Returns
        -------
        str
            this Quantity key attribute
        """
        return self._json_attrs.key

    @property
    @beartype
    def value(self) -> Union[int, float, str]:
        """
        amount of Material

        Examples
        --------
        >>> import cript
        >>> my_quantity = cript.Quantity(
        ...     key="mass", value=11.2, unit="kg", uncertainty=0.2, uncertainty_type="stdev"
        ... )
        >>> my_quantity.value = 1

        Returns
        -------
        Union[int, float, str]
            amount of Material
        """
        return self._json_attrs.value  # type: ignore

    @value.setter
    @beartype
    def value(self, new_value: Union[Number, str, None]) -> None:
        """
        set the amount of Material

        Parameters
        ----------
        new_value : Union[int, float, str]
            amount of Material

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

    @property
    @beartype
    def unit(self) -> str:
        """
        get the Quantity unit attribute

        Returns
        -------
        str
            unit for the Quantity value attribute
        """
        return self._json_attrs.unit

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

        Returns
        -------
        Number
            uncertainty value
        """
        return self._json_attrs.uncertainty  # type: ignore

    @property
    @beartype
    def uncertainty_type(self) -> str:
        """
        get the uncertainty type attribute for the Quantity sub-object

        [Uncertainty type](https://app.criptapp.org/vocab/uncertainty_type) must come from CRIPT controlled vocabulary

        Returns
        -------
        str
            uncertainty type
        """
        return self._json_attrs.uncertainty_type

    @beartype
    def set_uncertainty(self, uncertainty: Optional[Number], type: str) -> None:
        """
        set the `uncertainty value` and `uncertainty_type`

        Uncertainty and uncertainty type are set at the same time to keep the value and type in sync

        `uncertainty_type` must come from
        [CRIPT Controlled Vocabulary](https://app.criptapp.org/vocab/uncertainty_type)

        Examples
        --------
        >>> import cript
        >>> my_quantity = cript.Quantity(
        ...     key="mass", value=11.2, unit="kg", uncertainty=0.2, uncertainty_type="stdev"
        ... )

        Parameters
        ----------
        uncertainty : Number
            uncertainty value
        type : str
            type of uncertainty, uncertainty_type must come from
            [CRIPT Controlled Vocabulary](https://app.criptapp.org/vocab/uncertainty_type)

        Returns
        -------
        None
        """
        new_attrs = replace(self._json_attrs, uncertainty=uncertainty, uncertainty_type=type)
        self._update_json_attrs_if_valid(new_attrs)

__init__(key, value, unit, uncertainty=None, uncertainty_type='', **kwargs)

create Quantity sub-object

Parameters:

Name Type Description Default
key str

type of quantity. Quantity key must come from CRIPT Controlled Vocabulary

 required
value Number

amount of material

 required
unit str

unit for quantity

 required
uncertainty Union[Number, None]

uncertainty of value, by default None

 None
uncertainty_type str

type of uncertainty. Quantity uncertainty type must come from CRIPT Controlled Vocabulary, by default ""

 ''

Examples:

>>> import cript
>>> my_quantity = cript.Quantity(
...     key="mass", value=11.2, unit="kg", uncertainty=0.2, uncertainty_type="stdev"
... )

Returns:

Type Description
None

create Quantity sub-object
Source code in src/cript/nodes/subobjects/quantity.py 
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
@beartype
def __init__(self, key: str, value: Number, unit: str, uncertainty: Optional[Number] = None, uncertainty_type: str = "", **kwargs):
    """
    create Quantity sub-object

    Parameters
    ----------
    key : str
        type of quantity. Quantity key must come from
        [CRIPT Controlled Vocabulary](https://app.criptapp.org/vocab/quantity_key)
    value : Number
        amount of material
    unit : str
        unit for quantity
    uncertainty : Union[Number, None], optional
        uncertainty of value, by default None
    uncertainty_type : str, optional
        type of uncertainty. Quantity uncertainty type must come from
        [CRIPT Controlled Vocabulary](https://app.criptapp.org/vocab/uncertainty_type), by default ""

    Examples
    --------
    >>> import cript
    >>> my_quantity = cript.Quantity(
    ...     key="mass", value=11.2, unit="kg", uncertainty=0.2, uncertainty_type="stdev"
    ... )

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

key()

get the Quantity sub-object key attribute

Quantity type must come from CRIPT controlled vocabulary

Returns:

Type Description
str

this Quantity key attribute
Source code in src/cript/nodes/subobjects/quantity.py 
140
141
142
143
144
145
146
147
148
149
150
151
152
153
@property
@beartype
def key(self) -> str:
    """
    get the Quantity sub-object key attribute

    [Quantity type](https://app.criptapp.org/vocab/quantity_key) must come from CRIPT controlled vocabulary

    Returns
    -------
    str
        this Quantity key attribute
    """
    return self._json_attrs.key

set_key_unit(new_key, new_unit)

set the Quantity key and unit attributes

Quantity key must come from CRIPT Controlled Vocabulary

Examples:

>>> import cript
>>> my_quantity = cript.Quantity(
...     key="mass", value=11.2, unit="kg", uncertainty=0.2, uncertainty_type="stdev"
... )
>>> my_quantity.set_key_unit(new_key="mass", new_unit="kg")

Parameters:

Name Type Description Default
new_key str

new Quantity key. Quantity key must come from CRIPT Controlled Vocabulary

 required
new_unit str

new unit

 required

Returns:

Type Description
None
Source code in src/cript/nodes/subobjects/quantity.py 
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
@beartype
def set_key_unit(self, new_key: str, new_unit: str) -> None:
    """
    set the Quantity key and unit attributes

    Quantity key must come from [CRIPT Controlled Vocabulary](https://app.criptapp.org/vocab/quantity_key)

    Examples
    --------
    >>> import cript
    >>> my_quantity = cript.Quantity(
    ...     key="mass", value=11.2, unit="kg", uncertainty=0.2, uncertainty_type="stdev"
    ... )
    >>> my_quantity.set_key_unit(new_key="mass", new_unit="kg")

    Parameters
    ----------
    new_key : str
        new Quantity key. Quantity key must come from
        [CRIPT Controlled Vocabulary](https://app.criptapp.org/vocab/quantity_key)
    new_unit : str
        new unit

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

set_uncertainty(uncertainty, type)

set the uncertainty value and uncertainty_type

Uncertainty and uncertainty type are set at the same time to keep the value and type in sync

uncertainty_type must come from CRIPT Controlled Vocabulary

Examples:

>>> import cript
>>> my_quantity = cript.Quantity(
...     key="mass", value=11.2, unit="kg", uncertainty=0.2, uncertainty_type="stdev"
... )

Parameters:

Name Type Description Default
uncertainty Number

uncertainty value

 required
type str

type of uncertainty, uncertainty_type must come from CRIPT Controlled Vocabulary

 required

Returns:

Type Description
None
Source code in src/cript/nodes/subobjects/quantity.py 
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
@beartype
def set_uncertainty(self, uncertainty: Optional[Number], type: str) -> None:
    """
    set the `uncertainty value` and `uncertainty_type`

    Uncertainty and uncertainty type are set at the same time to keep the value and type in sync

    `uncertainty_type` must come from
    [CRIPT Controlled Vocabulary](https://app.criptapp.org/vocab/uncertainty_type)

    Examples
    --------
    >>> import cript
    >>> my_quantity = cript.Quantity(
    ...     key="mass", value=11.2, unit="kg", uncertainty=0.2, uncertainty_type="stdev"
    ... )

    Parameters
    ----------
    uncertainty : Number
        uncertainty value
    type : str
        type of uncertainty, uncertainty_type must come from
        [CRIPT Controlled Vocabulary](https://app.criptapp.org/vocab/uncertainty_type)

    Returns
    -------
    None
    """
    new_attrs = replace(self._json_attrs, uncertainty=uncertainty, uncertainty_type=type)
    self._update_json_attrs_if_valid(new_attrs)

uncertainty()

get the uncertainty value

Returns:

Type Description
Number

uncertainty value
Source code in src/cript/nodes/subobjects/quantity.py 
207
208
209
210
211
212
213
214
215
216
217
218
@property
@beartype
def uncertainty(self) -> Optional[Number]:
    """
    get the uncertainty value

    Returns
    -------
    Number
        uncertainty value
    """
    return self._json_attrs.uncertainty  # type: ignore

uncertainty_type()

get the uncertainty type attribute for the Quantity sub-object

Uncertainty type must come from CRIPT controlled vocabulary

Returns:

Type Description
str

uncertainty type
Source code in src/cript/nodes/subobjects/quantity.py 
220
221
222
223
224
225
226
227
228
229
230
231
232
233
@property
@beartype
def uncertainty_type(self) -> str:
    """
    get the uncertainty type attribute for the Quantity sub-object

    [Uncertainty type](https://app.criptapp.org/vocab/uncertainty_type) must come from CRIPT controlled vocabulary

    Returns
    -------
    str
        uncertainty type
    """
    return self._json_attrs.uncertainty_type

unit()

get the Quantity unit attribute

Returns:

Type Description
str

unit for the Quantity value attribute
Source code in src/cript/nodes/subobjects/quantity.py 
194
195
196
197
198
199
200
201
202
203
204
205
@property
@beartype
def unit(self) -> str:
    """
    get the Quantity unit attribute

    Returns
    -------
    str
        unit for the Quantity value attribute
    """
    return self._json_attrs.unit

value(new_value)

set the amount of Material

Parameters:

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

amount of Material

 required

Returns:

Type Description
None
Source code in src/cript/nodes/subobjects/quantity.py 
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
@value.setter
@beartype
def value(self, new_value: Union[Number, str, None]) -> None:
    """
    set the amount of Material

    Parameters
    ----------
    new_value : Union[int, float, str]
        amount of Material

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