Skip to content

Material

Material

Bases: PrimaryBaseNode

Definition

A Material node is a collection of the properties of a chemical, mixture, or substance.

Attributes
attribute type example description required vocab
component list[Material] list of component that make up the mixture
property list[Property] material properties
process Process process node that made this material
parent_material Material material node that this node was copied from
computational_forcefield Computation Forcefield computation forcefield Conditional
keyword list[str] [thermoplastic, homopolymer, linear, polyolefins] words that classify the material True
notes str "my awesome notes" miscellaneous information, or custom data structure True
amino_acid str "LeuProHis" if the material is an amino acid sequence, list it. Conditional
bigsmiles str "CC{[$][]CC[$][]}" BigSMILES string for polymer Conditional
chem_formula str "C22H33NO10" Chemical formula of the material or monomer Conditional
chem_repeat str "C=Cc1ccccc1" Chemical formula of the repeat unit Conditional
chemical_id str "126094" Unique chemical ID Conditional
inchi str "InChI=1S/H2O/h1H2" InChI string of the chemical Conditional
inchi_key str "XLYOFNOQVPJJNP-UHFFFAOYSA-N" InChI key of the chemical Conditional
lot_number str "123" Lot number of the chemical Conditional
names list[str] ["water", "Hydrogen oxide"] Alternative names that are being used Conditional
pubchem_cid int 962 PubChemID of the chemical Conditional
smiles str "O" Smiles string of the chemical Conditional
vendor str "fisher scientific" Vendor the chemical was purchased from Conditional
Navigating to Material

Materials can be easily found on the CRIPT home screen in the under the navigation within the Materials link

Available Sub-Objects for Material
Example

water, brine (water + NaCl), polystyrene, polyethylene glycol hydrogels, vulcanized polyisoprene, mcherry (protein), and mica

Warnings

Material names

Material names Must be unique within a Project

  {
     "node":["Material"],
     "name":"my unique material name",
     "uid":"_:9679ff12-f9b4-41f4-be95-080b78fa71fd",
     "uuid":"9679ff12-f9b4-41f4-be95-080b78fa71fd"
     "bigsmiles":"[H]{[>][<]C(C[>])c1ccccc1[]}",
  }
Source code in src/cript/nodes/primary_nodes/material.py
 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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
class Material(PrimaryBaseNode):
    """
    ## Definition
    A [Material node](https://pubs.acs.org/doi/suppl/10.1021/acscentsci.3c00011/suppl_file/oc3c00011_si_001.pdf#page=10)
    is a collection of the properties of a chemical, mixture, or substance.

    ## Attributes
    | attribute                 | type                                                                 | example                                           | description                                         | required    | vocab |
    |---------------------------|----------------------------------------------------------------------|---------------------------------------------------|-----------------------------------------------------|-------------|-------|
    | component                 | list[[Material](./)]                                                 |                                                   | list of component that make up the mixture          |             |       |
    | property                  | list[[Property](../../subobjects/property)]                          |                                                   | material properties                                 |             |       |
    | process                   | [Process](../process)                                                |                                                   | process node that made this material                |             |       |
    | parent_material           | [Material](./)                                                       |                                                   | material node that this node was copied from        |             |       |
    | computational_forcefield  | [Computation  Forcefield](../../subobjects/computational_forcefield) |                                                   | computation forcefield                              | Conditional |       |
    | keyword                   | list[str]                                                            | [thermoplastic, homopolymer, linear, polyolefins] | words that classify the material                    |             | True  |
    | notes                     | str                                                                  | "my awesome notes"                                | miscellaneous information, or custom data structure |             | True  |
    | amino_acid                | str                                                                  | "LeuProHis"                                       | if the material is an amino acid sequence, list it. | Conditional |       |
    | bigsmiles                 | str                                                                  | "CC{[$][$]CC[$][]}"                               | BigSMILES string for polymer                        | Conditional |       |
    | chem_formula              | str                                                                  | "C22H33NO10"                                      | Chemical formula of the material or monomer        | Conditional |       |
    | chem_repeat               | str                                                                  | "C=Cc1ccccc1"                                     | Chemical formula of the repeat unit                | Conditional |       |
    | chemical_id               | str                                                                  | "126094"                                          | Unique chemical ID                                  | Conditional |       |
    | inchi                     | str                                                                  | "InChI=1S/H2O/h1H2"                               | InChI string of the chemical                        | Conditional |       |
    | inchi_key                 | str                                                                  | "XLYOFNOQVPJJNP-UHFFFAOYSA-N"                     | InChI key of the chemical                           | Conditional |       |
    | lot_number                | str                                                                  | "123"                                             | Lot number of the chemical                          | Conditional |       |
    | names                     | list[str]                                                            | ["water", "Hydrogen oxide"]                       | Alternative names that are being used               | Conditional |       |
    | pubchem_cid               | int                                                                  | 962                                               | PubChemID of the chemical                           | Conditional |       |
    | smiles                    | str                                                                  | "O"                                               | Smiles string of the chemical                       | Conditional |       |
    | vendor                    | str                                                                  | "fisher scientific"                               | Vendor the chemical was purchased from              | Conditional |       |


    ## Navigating to Material
    Materials can be easily found on the [CRIPT](https://app.criptapp.org) home screen in the
    under the navigation within the [Materials link](https://app.criptapp.org/material/)

    ## Available Sub-Objects for Material
    * [Property](../../subobjects/property)
    * [Computational_forcefield](../../subobjects/computational_forcefield)

    Example
    -------
     water, brine (water + NaCl), polystyrene, polyethylene glycol hydrogels, vulcanized polyisoprene, mcherry (protein), and mica


    Warnings
    -------
    !!! warning "Material names"
        Material names Must be unique within a [Project](../project)

    ```json
      {
         "node":["Material"],
         "name":"my unique material name",
         "uid":"_:9679ff12-f9b4-41f4-be95-080b78fa71fd",
         "uuid":"9679ff12-f9b4-41f4-be95-080b78fa71fd"
         "bigsmiles":"[H]{[>][<]C(C[>])c1ccccc1[]}",
      }
    ```
    """

    @dataclass(frozen=True)
    class JsonAttributes(PrimaryBaseNode.JsonAttributes):
        """
        all Material attributes
        """

        # TODO add proper typing in future, using Any for now to avoid circular import error
        component: List[Union["Material", UIDProxy]] = field(default_factory=list)
        process: Optional[Union[Process, UIDProxy]] = None
        property: List[Union[Any, UIDProxy]] = field(default_factory=list)
        parent_material: Optional[Union["Material", UIDProxy]] = None
        computational_forcefield: Optional[Union[Any, UIDProxy]] = None
        keyword: List[str] = field(default_factory=list)
        amino_acid: Optional[str] = None
        bigsmiles: Optional[str] = None
        chem_formula: Optional[str] = None
        chem_repeat: List[str] = field(default_factory=list)
        chemical_id: Optional[str] = None
        inchi: Optional[str] = None
        inchi_key: Optional[str] = None
        lot_number: Optional[str] = None
        names: List[str] = field(default_factory=list)
        pubchem_cid: Optional[int] = None
        smiles: Optional[str] = None
        vendor: Optional[str] = None

    _json_attrs: JsonAttributes = JsonAttributes()

    @beartype
    def __init__(
        self,
        name: str,
        component: Optional[List[Union["Material", UIDProxy]]] = None,
        process: Optional[Union[Process, UIDProxy]] = None,
        property: Optional[List[Union[Any, UIDProxy]]] = None,
        parent_material: Optional[Union["Material", UIDProxy]] = None,
        computational_forcefield: Optional[Union[Any, UIDProxy]] = None,
        keyword: Optional[List[str]] = None,
        amino_acid: Optional[str] = None,
        bigsmiles: Optional[str] = None,
        chem_formula: Optional[str] = None,
        chem_repeat: Optional[List[str]] = None,
        chemical_id: Optional[str] = None,
        inchi: Optional[str] = None,
        inchi_key: Optional[str] = None,
        lot_number: Optional[str] = None,
        names: Optional[List[str]] = None,
        pubchem_cid: Optional[int] = None,
        smiles: Optional[str] = None,
        vendor: Optional[str] = None,
        notes: str = "",
        **kwargs
    ):
        """
        create a material node

        Examples
        --------
        >>> import cript
        >>> my_material = cript.Material(
        ...     name="my component material 1",
        ...     amino_acid = "component 1 alternative name",
        ... )

        Parameters
        ----------
        name: str
        component: List["Material"], default=None
        property: Optional[Process], default=None
        process: List[Process], default=None
        parent_material: "Material", default=None
        computational_forcefield: ComputationalForcefield, default=None
        keyword: List[str], default=None
        amino_acid: Optional[str] = None,
        bigsmiles: Optional[str] = None,
        chem_formula: Optional[str] = None,
        chem_repeat: Optional[List[str]] = None,
        chemical_id: Optional[str] = None,
        inchi: Optional[str] = None,
        inchi_key: Optional[str] = None,
        lot_number: Optional[str] = None,
        names: Optional[List[str]] = None,
        pubchem_cid: Optional[int] = None,
        smiles: Optional[str] = None,
        vendor: Optional[str] = None,

        Returns
        -------
        None
            Instantiate a material node
        """

        super().__init__(name=name, notes=notes, **kwargs)

        if component is None:
            component = []

        if property is None:
            property = []

        if keyword is None:
            keyword = []

        if chem_repeat is None:
            chem_repeat = []

        if names is None:
            names = []

        new_json_attrs = replace(
            self._json_attrs,
            name=name,
            component=component,
            process=process,
            property=property,
            parent_material=parent_material,
            computational_forcefield=computational_forcefield,
            keyword=keyword,
            amino_acid=amino_acid,
            bigsmiles=bigsmiles,
            chem_formula=chem_formula,
            chem_repeat=chem_repeat,
            chemical_id=chemical_id,
            inchi=inchi,
            inchi_key=inchi_key,
            lot_number=lot_number,
            names=names,
            pubchem_cid=pubchem_cid,
            smiles=smiles,
            vendor=vendor,
        )
        self._update_json_attrs_if_valid(new_json_attrs)

    def validate(self, api=None, is_patch: bool = False, force_validation: bool = False) -> None:
        super().validate(api=api, is_patch=is_patch, force_validation=force_validation)

        if (
            self.amino_acid is None
            and self.bigsmiles is None
            and self.chem_formula is None
            and len(self.chem_repeat) == 0
            and self.chemical_id is None
            and self.inchi_key is None
            and self.inchi is None
            and self.lot_number is None
            and len(self.names) == 0
            and self.pubchem_cid is None
            and self.smiles is None
            and self.vendor is None
        ):
            warnings.warn(CRIPTMaterialIdentifierWarning(self))

    @property
    @beartype
    def amino_acid(self) -> Union[str, None]:
        return self._json_attrs.amino_acid

    @amino_acid.setter
    @beartype
    def amino_acid(self, new_amino_acid: str) -> None:
        new_attrs = replace(self._json_attrs, amino_acid=new_amino_acid)
        self._update_json_attrs_if_valid(new_attrs)

    @property
    @beartype
    def bigsmiles(self) -> Union[str, None]:
        return self._json_attrs.bigsmiles

    @bigsmiles.setter
    @beartype
    def bigsmiles(self, new_bigsmiles: str) -> None:
        new_attrs = replace(self._json_attrs, bigsmiles=new_bigsmiles)
        self._update_json_attrs_if_valid(new_attrs)

    @property
    @beartype
    def chem_formula(self) -> Union[str, None]:
        return self._json_attrs.chem_formula

    @chem_formula.setter
    @beartype
    def chem_formula(self, new_chem_formula: str) -> None:
        new_attrs = replace(self._json_attrs, chem_formula=new_chem_formula)
        self._update_json_attrs_if_valid(new_attrs)

    @property
    @beartype
    def chemical_id(self) -> Union[str, None]:
        return self._json_attrs.chemical_id

    @chemical_id.setter
    @beartype
    def chemical_id(self, new_chemical_id: str) -> None:
        new_attrs = replace(self._json_attrs, chemical_id=new_chemical_id)
        self._update_json_attrs_if_valid(new_attrs)

    @property
    @beartype
    def inchi(self) -> Union[str, None]:
        return self._json_attrs.inchi

    @inchi.setter
    @beartype
    def inchi(self, new_inchi: str) -> None:
        new_attrs = replace(self._json_attrs, inchi=new_inchi)
        self._update_json_attrs_if_valid(new_attrs)

    @property
    @beartype
    def inchi_key(self) -> Union[str, None]:
        return self._json_attrs.inchi_key

    @inchi_key.setter
    @beartype
    def inchi_key(self, new_inchi_key: str) -> None:
        new_attrs = replace(self._json_attrs, inchi_key=new_inchi_key)
        self._update_json_attrs_if_valid(new_attrs)

    @property
    @beartype
    def lot_number(self) -> Union[str, None]:
        return self._json_attrs.lot_number

    @lot_number.setter
    @beartype
    def lot_number(self, new_lot_number: str) -> None:
        new_attrs = replace(self._json_attrs, lot_number=new_lot_number)
        self._update_json_attrs_if_valid(new_attrs)

    @property
    @beartype
    def smiles(self) -> Union[str, None]:
        return self._json_attrs.smiles

    @smiles.setter
    @beartype
    def smiles(self, new_smiles: str) -> None:
        new_attrs = replace(self._json_attrs, smiles=new_smiles)
        self._update_json_attrs_if_valid(new_attrs)

    @property
    @beartype
    def vendor(self) -> Union[str, None]:
        return self._json_attrs.vendor

    @vendor.setter
    @beartype
    def vendor(self, new_vendor: str) -> None:
        new_attrs = replace(self._json_attrs, vendor=new_vendor)
        self._update_json_attrs_if_valid(new_attrs)

    @property
    @beartype
    def chem_repeat(self) -> List[str]:
        return self._json_attrs.chem_repeat.copy()

    @chem_repeat.setter
    @beartype
    def chem_repeat(self, new_chem_repeat: List[str]) -> None:
        new_attrs = replace(self._json_attrs, chem_repeat=new_chem_repeat)
        self._update_json_attrs_if_valid(new_attrs)

    @property
    @beartype
    def names(self) -> List[str]:
        return self._json_attrs.names.copy()

    @names.setter
    @beartype
    def names(self, new_names: List[str]) -> None:
        new_attrs = replace(self._json_attrs, names=new_names)
        self._update_json_attrs_if_valid(new_attrs)

    @property
    @beartype
    def pubchem_cid(self) -> Union[int, None]:
        return self._json_attrs.pubchem_cid

    @pubchem_cid.setter
    @beartype
    def pubchem_cid(self, new_pubchem_cid: int) -> None:
        new_attrs = replace(self._json_attrs, pubchem_cid=new_pubchem_cid)
        self._update_json_attrs_if_valid(new_attrs)

    @property
    @beartype
    def component(self) -> List[Union["Material", UIDProxy]]:
        """
        list of components ([material nodes](./)) that make up this material

        Examples
        ---------
        >>> import cript
        >>> my_components = [
        ...     cript.Material(
        ...         name="my component material 1",
        ...         smiles="my material smiles",
        ...     ),
        ...     cript.Material(
        ...         name="my component material 2",
        ...         vendor= "my material vendor",
        ...     ),
        ... ]
        >>> my_mixed_material = cript.Material(
        ...     name="my material",
        ...     component=my_components,
        ...     bigsmiles = "123456",
        ... )

        Returns
        -------
        List[Material]
            list of component that make up this material
        """
        return self._json_attrs.component

    @component.setter
    @beartype
    def component(self, new_component_list: List[Union["Material", UIDProxy]]) -> None:
        """
        set the list of component (material nodes) that make up this material

        Parameters
        ----------
        new_component_list: List["Material"]

        Returns
        -------
        None
        """
        new_attrs = replace(self._json_attrs, component=new_component_list)
        self._update_json_attrs_if_valid(new_attrs)

    @property
    @beartype
    def parent_material(self) -> Optional[Union["Material", UIDProxy]]:
        """
        List of parent materials

        Returns
        -------
        List["Material"]
            list of parent materials
        """
        return self._json_attrs.parent_material

    @parent_material.setter
    @beartype
    def parent_material(self, new_parent_material: Optional[Union["Material", UIDProxy]]) -> None:
        """
        set the [parent materials](./) for this material

        Parameters
        ----------
        new_parent_material: "Material"

        Returns
        -------
        None
        """

        new_attrs = replace(self._json_attrs, parent_material=new_parent_material)
        self._update_json_attrs_if_valid(new_attrs)

    @property
    @beartype
    def computational_forcefield(self) -> Any:
        """
        list of [computational_forcefield](../../subobjects/computational_forcefield) for this material node

        Examples
        --------
        >>> import cript
        >>> my_material = cript.Material(
        ...     name="my component material 1", smiles= "my smiles"
        ... )
        >>> my_computational_forcefield = cript.ComputationalForcefield(
        ...     key="opls_aa",
        ...     building_block="atom",
        ... )
        >>> my_material.computational_forcefield = my_computational_forcefield

        Returns
        -------
        List[ComputationForcefield]
            list of computational_forcefield that created this material
        """
        return self._json_attrs.computational_forcefield

    @computational_forcefield.setter
    @beartype
    def computational_forcefield(self, new_computational_forcefield: Any) -> None:
        """
        sets the list of computational forcefields for this material

        Parameters
        ----------
        new_computation_forcefield: ComputationalForcefield

        Returns
        -------
        None
        """
        new_attrs = replace(self._json_attrs, computational_forcefield=new_computational_forcefield)
        self._update_json_attrs_if_valid(new_attrs)

    @property
    @beartype
    def keyword(self) -> List[str]:
        """
        List of keyword for this material

        the material keyword must come from the
        [CRIPT controlled vocabulary](https://app.criptapp.org/vocab/material_keyword)

        Examples
        --------
        >>> import cript
        >>> my_material = cript.Material(
        ... name="my material", inchi = "my material inchi"
        ... )
        >>> my_material.keyword = ["acetylene", "acrylate", "alternating"]

        Returns
        -------
        List[str]
            list of material keyword
        """
        return self._json_attrs.keyword

    @keyword.setter
    @beartype
    def keyword(self, new_keyword_list: List[str]) -> None:
        """
        set the keyword for this material

        the material keyword must come from the CRIPT controlled vocabulary

        Parameters
        ----------
        new_keyword_list

        Returns
        -------
        None
        """
        new_attrs = replace(self._json_attrs, keyword=new_keyword_list)
        self._update_json_attrs_if_valid(new_attrs)

    @property
    @beartype
    def process(self) -> Optional[Union[Process, UIDProxy]]:
        return self._json_attrs.process  # type: ignore

    @process.setter
    def process(self, new_process: Union[Process, UIDProxy]) -> None:
        new_attrs = replace(self._json_attrs, process=new_process)
        self._update_json_attrs_if_valid(new_attrs)

    @property
    def property(self) -> List[Any]:
        """
        list of material [property](../../subobjects/property)

        Examples
        --------
        >>> import cript
        >>> my_material = cript.Material(
        ...     name="my component material 1",
        ...     smiles = "component 1 smiles",
        ... )
        >>> my_property = cript.Property(key="enthalpy", type="min", value=1.23, unit="J")
        >>> my_material.property = [my_property]

        Returns
        -------
        List[Property]
            list of property that define this material
        """
        return self._json_attrs.property.copy()

    @property.setter
    @beartype
    def property(self, new_property_list: List[Any]) -> None:
        """
        set the list of properties for this material

        Parameters
        ----------
        new_property_list: List[Property]

        Returns
        -------
        None
        """
        new_attrs = replace(self._json_attrs, property=new_property_list)
        self._update_json_attrs_if_valid(new_attrs)

component: List[Union[Material, UIDProxy]] property writable

list of components (material nodes) that make up this material

Examples:

>>> import cript
>>> my_components = [
...     cript.Material(
...         name="my component material 1",
...         smiles="my material smiles",
...     ),
...     cript.Material(
...         name="my component material 2",
...         vendor= "my material vendor",
...     ),
... ]
>>> my_mixed_material = cript.Material(
...     name="my material",
...     component=my_components,
...     bigsmiles = "123456",
... )

Returns:

Type Description
List[Material]

list of component that make up this material

computational_forcefield: Any property writable

list of computational_forcefield for this material node

Examples:

>>> import cript
>>> my_material = cript.Material(
...     name="my component material 1", smiles= "my smiles"
... )
>>> my_computational_forcefield = cript.ComputationalForcefield(
...     key="opls_aa",
...     building_block="atom",
... )
>>> my_material.computational_forcefield = my_computational_forcefield

Returns:

Type Description
List[ComputationForcefield]

list of computational_forcefield that created this material

keyword: List[str] property writable

List of keyword for this material

the material keyword must come from the CRIPT controlled vocabulary

Examples:

>>> import cript
>>> my_material = cript.Material(
... name="my material", inchi = "my material inchi"
... )
>>> my_material.keyword = ["acetylene", "acrylate", "alternating"]

Returns:

Type Description
List[str]

list of material keyword

parent_material: Optional[Union[Material, UIDProxy]] property writable

List of parent materials

Returns:

Type Description
List[Material]

list of parent materials

property: List[Any] property writable

list of material property

Examples:

>>> import cript
>>> my_material = cript.Material(
...     name="my component material 1",
...     smiles = "component 1 smiles",
... )
>>> my_property = cript.Property(key="enthalpy", type="min", value=1.23, unit="J")
>>> my_material.property = [my_property]

Returns:

Type Description
List[Property]

list of property that define this material

JsonAttributes dataclass

Bases: JsonAttributes

all Material attributes

Source code in src/cript/nodes/primary_nodes/material.py
@dataclass(frozen=True)
class JsonAttributes(PrimaryBaseNode.JsonAttributes):
    """
    all Material attributes
    """

    # TODO add proper typing in future, using Any for now to avoid circular import error
    component: List[Union["Material", UIDProxy]] = field(default_factory=list)
    process: Optional[Union[Process, UIDProxy]] = None
    property: List[Union[Any, UIDProxy]] = field(default_factory=list)
    parent_material: Optional[Union["Material", UIDProxy]] = None
    computational_forcefield: Optional[Union[Any, UIDProxy]] = None
    keyword: List[str] = field(default_factory=list)
    amino_acid: Optional[str] = None
    bigsmiles: Optional[str] = None
    chem_formula: Optional[str] = None
    chem_repeat: List[str] = field(default_factory=list)
    chemical_id: Optional[str] = None
    inchi: Optional[str] = None
    inchi_key: Optional[str] = None
    lot_number: Optional[str] = None
    names: List[str] = field(default_factory=list)
    pubchem_cid: Optional[int] = None
    smiles: Optional[str] = None
    vendor: Optional[str] = None

__init__(name, component=None, process=None, property=None, parent_material=None, computational_forcefield=None, keyword=None, amino_acid=None, bigsmiles=None, chem_formula=None, chem_repeat=None, chemical_id=None, inchi=None, inchi_key=None, lot_number=None, names=None, pubchem_cid=None, smiles=None, vendor=None, notes='', **kwargs)

create a material node

Examples:

>>> import cript
>>> my_material = cript.Material(
...     name="my component material 1",
...     amino_acid = "component 1 alternative name",
... )

Parameters:

Name Type Description Default
name str
required
component Optional[List[Union[Material, UIDProxy]]]
None
property Optional[List[Union[Any, UIDProxy]]]
None
process Optional[Union[Process, UIDProxy]]
None
parent_material Optional[Union[Material, UIDProxy]]
None
computational_forcefield Optional[Union[Any, UIDProxy]]
None
keyword Optional[List[str]]
None
amino_acid Optional[str]
None
bigsmiles Optional[str]
None
chem_formula Optional[str]
None
chem_repeat Optional[List[str]]
None
chemical_id Optional[str]
None
inchi Optional[str]
None
inchi_key Optional[str]
None
lot_number Optional[str]
None
names Optional[List[str]]
None
pubchem_cid Optional[int]
None
smiles Optional[str]
None
vendor Optional[str]
None

Returns:

Type Description
None

Instantiate a material node

Source code in src/cript/nodes/primary_nodes/material.py
@beartype
def __init__(
    self,
    name: str,
    component: Optional[List[Union["Material", UIDProxy]]] = None,
    process: Optional[Union[Process, UIDProxy]] = None,
    property: Optional[List[Union[Any, UIDProxy]]] = None,
    parent_material: Optional[Union["Material", UIDProxy]] = None,
    computational_forcefield: Optional[Union[Any, UIDProxy]] = None,
    keyword: Optional[List[str]] = None,
    amino_acid: Optional[str] = None,
    bigsmiles: Optional[str] = None,
    chem_formula: Optional[str] = None,
    chem_repeat: Optional[List[str]] = None,
    chemical_id: Optional[str] = None,
    inchi: Optional[str] = None,
    inchi_key: Optional[str] = None,
    lot_number: Optional[str] = None,
    names: Optional[List[str]] = None,
    pubchem_cid: Optional[int] = None,
    smiles: Optional[str] = None,
    vendor: Optional[str] = None,
    notes: str = "",
    **kwargs
):
    """
    create a material node

    Examples
    --------
    >>> import cript
    >>> my_material = cript.Material(
    ...     name="my component material 1",
    ...     amino_acid = "component 1 alternative name",
    ... )

    Parameters
    ----------
    name: str
    component: List["Material"], default=None
    property: Optional[Process], default=None
    process: List[Process], default=None
    parent_material: "Material", default=None
    computational_forcefield: ComputationalForcefield, default=None
    keyword: List[str], default=None
    amino_acid: Optional[str] = None,
    bigsmiles: Optional[str] = None,
    chem_formula: Optional[str] = None,
    chem_repeat: Optional[List[str]] = None,
    chemical_id: Optional[str] = None,
    inchi: Optional[str] = None,
    inchi_key: Optional[str] = None,
    lot_number: Optional[str] = None,
    names: Optional[List[str]] = None,
    pubchem_cid: Optional[int] = None,
    smiles: Optional[str] = None,
    vendor: Optional[str] = None,

    Returns
    -------
    None
        Instantiate a material node
    """

    super().__init__(name=name, notes=notes, **kwargs)

    if component is None:
        component = []

    if property is None:
        property = []

    if keyword is None:
        keyword = []

    if chem_repeat is None:
        chem_repeat = []

    if names is None:
        names = []

    new_json_attrs = replace(
        self._json_attrs,
        name=name,
        component=component,
        process=process,
        property=property,
        parent_material=parent_material,
        computational_forcefield=computational_forcefield,
        keyword=keyword,
        amino_acid=amino_acid,
        bigsmiles=bigsmiles,
        chem_formula=chem_formula,
        chem_repeat=chem_repeat,
        chemical_id=chemical_id,
        inchi=inchi,
        inchi_key=inchi_key,
        lot_number=lot_number,
        names=names,
        pubchem_cid=pubchem_cid,
        smiles=smiles,
        vendor=vendor,
    )
    self._update_json_attrs_if_valid(new_json_attrs)