Skip to content

Controlled Vocabulary Categories

Bases: Enum

All available CRIPT controlled vocabulary categories

Controlled vocabulary categories are used to classify data.

Attributes:

Name Type Description
ALGORITHM_KEY str

Algorithm key.
ALGORITHM_TYPE str

Algorithm type.
BUILDING_BLOCK str

Building block.
CITATION_TYPE str

Citation type.
COMPUTATION_TYPE str

Computation type.
COMPUTATIONAL_FORCEFIELD_KEY str

Computational forcefield key.
COMPUTATIONAL_PROCESS_PROPERTY_KEY str

Computational process property key.
COMPUTATIONAL_PROCESS_TYPE str

Computational process type.
CONDITION_KEY str

Condition key.
DATA_LICENSE str

Data license.
DATA_TYPE str

Data type.
EQUIPMENT_KEY str

Equipment key.
FILE_TYPE str

File type.
INGREDIENT_KEYWORD str

Ingredient keyword.
MATERIAL_IDENTIFIER_KEY str

Material identifier key.
MATERIAL_KEYWORD str

Material keyword.
MATERIAL_PROPERTY_KEY str

Material property key.
PARAMETER_KEY str

Parameter key.
PROCESS_KEYWORD str

Process keyword.
PROCESS_PROPERTY_KEY str

Process property key.
PROCESS_TYPE str

Process type.
PROPERTY_METHOD str

Property method.
QUANTITY_KEY str

Quantity key.
REFERENCE_TYPE str

Reference type.
SET_TYPE str

Set type.
UNCERTAINTY_TYPE str

Uncertainty type.

Examples:

>>> import cript
>>> algorithm_vocabulary = api.schema.get_vocab_by_category(
...     cript.VocabCategories.ALGORITHM_KEY
... )
Source code in src/cript/api/vocabulary_categories.py 
 4
 5
 6
 7
 8
 9
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
class VocabCategories(Enum):
    """
    All available [CRIPT controlled vocabulary categories](https://app.criptapp.org/vocab/)

    Controlled vocabulary categories are used to classify data.

    Attributes
    ----------
    ALGORITHM_KEY: str
        Algorithm key.
    ALGORITHM_TYPE: str
        Algorithm type.
    BUILDING_BLOCK: str
        Building block.
    CITATION_TYPE: str
        Citation type.
    COMPUTATION_TYPE: str
       Computation type.
    COMPUTATIONAL_FORCEFIELD_KEY: str
        Computational forcefield key.
    COMPUTATIONAL_PROCESS_PROPERTY_KEY: str
        Computational process property key.
    COMPUTATIONAL_PROCESS_TYPE: str
        Computational process type.
    CONDITION_KEY: str
        Condition key.
    DATA_LICENSE: str
        Data license.
    DATA_TYPE: str
        Data type.
    EQUIPMENT_KEY: str
        Equipment key.
    FILE_TYPE: str
        File type.
    INGREDIENT_KEYWORD: str
        Ingredient keyword.
    MATERIAL_IDENTIFIER_KEY: str
        Material identifier key.
    MATERIAL_KEYWORD: str
        Material keyword.
    MATERIAL_PROPERTY_KEY: str
        Material property key.
    PARAMETER_KEY: str
        Parameter key.
    PROCESS_KEYWORD: str
        Process keyword.
    PROCESS_PROPERTY_KEY: str
        Process property key.
    PROCESS_TYPE: str
        Process type.
    PROPERTY_METHOD: str
        Property method.
    QUANTITY_KEY: str
        Quantity key.
    REFERENCE_TYPE: str
        Reference type.
    SET_TYPE: str
        Set type.
    UNCERTAINTY_TYPE: str
        Uncertainty type.

    Examples
    --------
    >>> import cript
    >>> algorithm_vocabulary = api.schema.get_vocab_by_category(
    ...     cript.VocabCategories.ALGORITHM_KEY
    ... )
    """

    ALGORITHM_KEY: str = "algorithm_key"
    ALGORITHM_TYPE: str = "algorithm_type"
    BUILDING_BLOCK: str = "building_block"
    CITATION_TYPE: str = "citation_type"
    COMPUTATION_TYPE: str = "computation_type"
    COMPUTATIONAL_FORCEFIELD_KEY: str = "computational_forcefield_key"
    COMPUTATIONAL_PROCESS_PROPERTY_KEY: str = "computational_process_property_key"
    COMPUTATIONAL_PROCESS_TYPE: str = "computational_process_type"
    CONDITION_KEY: str = "condition_key"
    DATA_LICENSE: str = "data_license"
    DATA_TYPE: str = "data_type"
    EQUIPMENT_KEY: str = "equipment_key"
    FILE_TYPE: str = "file_type"
    INGREDIENT_KEYWORD: str = "ingredient_keyword"
    MATERIAL_IDENTIFIER_KEY: str = "material_identifier_key"
    MATERIAL_KEYWORD: str = "material_keyword"
    MATERIAL_PROPERTY_KEY: str = "material_property_key"
    PARAMETER_KEY: str = "parameter_key"
    PROCESS_KEYWORD: str = "process_keyword"
    PROCESS_PROPERTY_KEY: str = "process_property_key"
    PROCESS_TYPE: str = "process_type"
    PROPERTY_METHOD: str = "property_method"
    QUANTITY_KEY: str = "quantity_key"
    REFERENCE_TYPE: str = "reference_type"
    SET_TYPE: str = "set_type"
    UNCERTAINTY_TYPE: str = "uncertainty_type"