valuesets 0.3.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of valuesets might be problematic. Click here for more details.

Files changed (248) hide show
  1. valuesets/__init__.py +7 -0
  2. valuesets/_version.py +8 -0
  3. valuesets/datamodel/valuesets.py +13796 -0
  4. valuesets/datamodel/valuesets_dataclass.py +24503 -0
  5. valuesets/datamodel/valuesets_pydantic.py +13796 -0
  6. valuesets/enums/__init__.py +590 -0
  7. valuesets/enums/academic/__init__.py +1 -0
  8. valuesets/enums/academic/research.py +559 -0
  9. valuesets/enums/analytical_chemistry/__init__.py +1 -0
  10. valuesets/enums/analytical_chemistry/mass_spectrometry.py +198 -0
  11. valuesets/enums/bio/__init__.py +1 -0
  12. valuesets/enums/bio/biological_colors.py +238 -0
  13. valuesets/enums/bio/cell_cycle.py +180 -0
  14. valuesets/enums/bio/currency_chemicals.py +52 -0
  15. valuesets/enums/bio/developmental_stages.py +103 -0
  16. valuesets/enums/bio/genome_features.py +182 -0
  17. valuesets/enums/bio/genomics.py +91 -0
  18. valuesets/enums/bio/go_aspect.py +32 -0
  19. valuesets/enums/bio/go_causality.py +58 -0
  20. valuesets/enums/bio/go_evidence.py +129 -0
  21. valuesets/enums/bio/human_developmental_stages.py +62 -0
  22. valuesets/enums/bio/insdc_geographic_locations.py +591 -0
  23. valuesets/enums/bio/insdc_missing_values.py +49 -0
  24. valuesets/enums/bio/lipid_categories.py +67 -0
  25. valuesets/enums/bio/mouse_developmental_stages.py +62 -0
  26. valuesets/enums/bio/plant_biology.py +86 -0
  27. valuesets/enums/bio/plant_developmental_stages.py +54 -0
  28. valuesets/enums/bio/plant_sex.py +81 -0
  29. valuesets/enums/bio/protein_evidence.py +61 -0
  30. valuesets/enums/bio/proteomics_standards.py +123 -0
  31. valuesets/enums/bio/psi_mi.py +306 -0
  32. valuesets/enums/bio/relationship_to_oxygen.py +37 -0
  33. valuesets/enums/bio/sequence_alphabets.py +449 -0
  34. valuesets/enums/bio/sequence_chemistry.py +357 -0
  35. valuesets/enums/bio/sequencing_platforms.py +302 -0
  36. valuesets/enums/bio/structural_biology.py +320 -0
  37. valuesets/enums/bio/taxonomy.py +238 -0
  38. valuesets/enums/bio/trophic_levels.py +85 -0
  39. valuesets/enums/bio/uniprot_species.py +344 -0
  40. valuesets/enums/bio/viral_genome_types.py +47 -0
  41. valuesets/enums/bioprocessing/__init__.py +1 -0
  42. valuesets/enums/bioprocessing/scale_up.py +249 -0
  43. valuesets/enums/business/__init__.py +1 -0
  44. valuesets/enums/business/human_resources.py +275 -0
  45. valuesets/enums/business/industry_classifications.py +181 -0
  46. valuesets/enums/business/management_operations.py +228 -0
  47. valuesets/enums/business/organizational_structures.py +236 -0
  48. valuesets/enums/business/quality_management.py +181 -0
  49. valuesets/enums/business/supply_chain.py +232 -0
  50. valuesets/enums/chemistry/__init__.py +1 -0
  51. valuesets/enums/chemistry/chemical_entities.py +315 -0
  52. valuesets/enums/chemistry/reaction_directionality.py +65 -0
  53. valuesets/enums/chemistry/reactions.py +256 -0
  54. valuesets/enums/clinical/__init__.py +1 -0
  55. valuesets/enums/clinical/nih_demographics.py +177 -0
  56. valuesets/enums/clinical/phenopackets.py +254 -0
  57. valuesets/enums/common_value_sets.py +8791 -0
  58. valuesets/enums/computing/__init__.py +1 -0
  59. valuesets/enums/computing/file_formats.py +294 -0
  60. valuesets/enums/computing/maturity_levels.py +196 -0
  61. valuesets/enums/computing/mime_types.py +227 -0
  62. valuesets/enums/confidence_levels.py +168 -0
  63. valuesets/enums/contributor.py +30 -0
  64. valuesets/enums/core.py +42 -0
  65. valuesets/enums/data/__init__.py +1 -0
  66. valuesets/enums/data/data_absent_reason.py +53 -0
  67. valuesets/enums/data_science/__init__.py +1 -0
  68. valuesets/enums/data_science/binary_classification.py +87 -0
  69. valuesets/enums/data_science/emotion_classification.py +66 -0
  70. valuesets/enums/data_science/priority_severity.py +73 -0
  71. valuesets/enums/data_science/quality_control.py +46 -0
  72. valuesets/enums/data_science/sentiment_analysis.py +50 -0
  73. valuesets/enums/data_science/text_classification.py +97 -0
  74. valuesets/enums/demographics.py +206 -0
  75. valuesets/enums/ecological_interactions.py +151 -0
  76. valuesets/enums/energy/__init__.py +1 -0
  77. valuesets/enums/energy/energy.py +343 -0
  78. valuesets/enums/energy/fossil_fuels.py +29 -0
  79. valuesets/enums/energy/nuclear/__init__.py +1 -0
  80. valuesets/enums/energy/nuclear/nuclear_facilities.py +195 -0
  81. valuesets/enums/energy/nuclear/nuclear_fuel_cycle.py +96 -0
  82. valuesets/enums/energy/nuclear/nuclear_fuels.py +175 -0
  83. valuesets/enums/energy/nuclear/nuclear_operations.py +191 -0
  84. valuesets/enums/energy/nuclear/nuclear_regulatory.py +188 -0
  85. valuesets/enums/energy/nuclear/nuclear_safety.py +164 -0
  86. valuesets/enums/energy/nuclear/nuclear_waste.py +158 -0
  87. valuesets/enums/energy/nuclear/reactor_types.py +163 -0
  88. valuesets/enums/environmental_health/__init__.py +1 -0
  89. valuesets/enums/environmental_health/exposures.py +265 -0
  90. valuesets/enums/geography/__init__.py +1 -0
  91. valuesets/enums/geography/geographic_codes.py +741 -0
  92. valuesets/enums/health/__init__.py +12 -0
  93. valuesets/enums/health/vaccination.py +98 -0
  94. valuesets/enums/health.py +36 -0
  95. valuesets/enums/health_base.py +36 -0
  96. valuesets/enums/healthcare.py +45 -0
  97. valuesets/enums/industry/__init__.py +1 -0
  98. valuesets/enums/industry/extractive_industry.py +94 -0
  99. valuesets/enums/industry/mining.py +388 -0
  100. valuesets/enums/industry/safety_colors.py +201 -0
  101. valuesets/enums/investigation.py +27 -0
  102. valuesets/enums/materials_science/__init__.py +1 -0
  103. valuesets/enums/materials_science/characterization_methods.py +112 -0
  104. valuesets/enums/materials_science/crystal_structures.py +76 -0
  105. valuesets/enums/materials_science/material_properties.py +119 -0
  106. valuesets/enums/materials_science/material_types.py +104 -0
  107. valuesets/enums/materials_science/pigments_dyes.py +198 -0
  108. valuesets/enums/materials_science/synthesis_methods.py +109 -0
  109. valuesets/enums/medical/__init__.py +1 -0
  110. valuesets/enums/medical/clinical.py +277 -0
  111. valuesets/enums/medical/neuroimaging.py +119 -0
  112. valuesets/enums/mining_processing.py +302 -0
  113. valuesets/enums/physics/__init__.py +1 -0
  114. valuesets/enums/physics/states_of_matter.py +46 -0
  115. valuesets/enums/social/__init__.py +1 -0
  116. valuesets/enums/social/person_status.py +29 -0
  117. valuesets/enums/spatial/__init__.py +1 -0
  118. valuesets/enums/spatial/spatial_qualifiers.py +246 -0
  119. valuesets/enums/statistics/__init__.py +5 -0
  120. valuesets/enums/statistics/prediction_outcomes.py +31 -0
  121. valuesets/enums/statistics.py +31 -0
  122. valuesets/enums/time/__init__.py +1 -0
  123. valuesets/enums/time/temporal.py +254 -0
  124. valuesets/enums/units/__init__.py +1 -0
  125. valuesets/enums/units/measurements.py +310 -0
  126. valuesets/enums/visual/__init__.py +1 -0
  127. valuesets/enums/visual/colors.py +376 -0
  128. valuesets/generators/__init__.py +19 -0
  129. valuesets/generators/auto_slot_injector.py +280 -0
  130. valuesets/generators/enhanced_pydantic_generator.py +100 -0
  131. valuesets/generators/enum_slot_generator.py +201 -0
  132. valuesets/generators/modular_rich_generator.py +353 -0
  133. valuesets/generators/prefix_standardizer.py +198 -0
  134. valuesets/generators/rich_enum.py +127 -0
  135. valuesets/generators/rich_pydantic_generator.py +310 -0
  136. valuesets/generators/smart_slot_syncer.py +428 -0
  137. valuesets/generators/sssom_generator.py +394 -0
  138. valuesets/merged/merged_hierarchy.yaml +21649 -0
  139. valuesets/schema/README.md +3 -0
  140. valuesets/schema/academic/research.yaml +911 -0
  141. valuesets/schema/analytical_chemistry/mass_spectrometry.yaml +206 -0
  142. valuesets/schema/bio/bio_entities.yaml +364 -0
  143. valuesets/schema/bio/biological_colors.yaml +434 -0
  144. valuesets/schema/bio/cell_cycle.yaml +309 -0
  145. valuesets/schema/bio/currency_chemicals.yaml +70 -0
  146. valuesets/schema/bio/developmental_stages.yaml +226 -0
  147. valuesets/schema/bio/genome_features.yaml +342 -0
  148. valuesets/schema/bio/genomics.yaml +101 -0
  149. valuesets/schema/bio/go_aspect.yaml +39 -0
  150. valuesets/schema/bio/go_causality.yaml +119 -0
  151. valuesets/schema/bio/go_evidence.yaml +215 -0
  152. valuesets/schema/bio/insdc_geographic_locations.yaml +911 -0
  153. valuesets/schema/bio/insdc_missing_values.yaml +85 -0
  154. valuesets/schema/bio/lipid_categories.yaml +72 -0
  155. valuesets/schema/bio/plant_biology.yaml +125 -0
  156. valuesets/schema/bio/plant_developmental_stages.yaml +77 -0
  157. valuesets/schema/bio/plant_sex.yaml +108 -0
  158. valuesets/schema/bio/protein_evidence.yaml +63 -0
  159. valuesets/schema/bio/proteomics_standards.yaml +116 -0
  160. valuesets/schema/bio/psi_mi.yaml +400 -0
  161. valuesets/schema/bio/relationship_to_oxygen.yaml +46 -0
  162. valuesets/schema/bio/sequence_alphabets.yaml +1168 -0
  163. valuesets/schema/bio/sequence_chemistry.yaml +477 -0
  164. valuesets/schema/bio/sequencing_platforms.yaml +515 -0
  165. valuesets/schema/bio/structural_biology.yaml +428 -0
  166. valuesets/schema/bio/taxonomy.yaml +453 -0
  167. valuesets/schema/bio/trophic_levels.yaml +118 -0
  168. valuesets/schema/bio/uniprot_species.yaml +1209 -0
  169. valuesets/schema/bio/viral_genome_types.yaml +99 -0
  170. valuesets/schema/bioprocessing/scale_up.yaml +458 -0
  171. valuesets/schema/business/human_resources.yaml +752 -0
  172. valuesets/schema/business/industry_classifications.yaml +448 -0
  173. valuesets/schema/business/management_operations.yaml +602 -0
  174. valuesets/schema/business/organizational_structures.yaml +645 -0
  175. valuesets/schema/business/quality_management.yaml +502 -0
  176. valuesets/schema/business/supply_chain.yaml +688 -0
  177. valuesets/schema/chemistry/chemical_entities.yaml +639 -0
  178. valuesets/schema/chemistry/reaction_directionality.yaml +60 -0
  179. valuesets/schema/chemistry/reactions.yaml +442 -0
  180. valuesets/schema/clinical/nih_demographics.yaml +285 -0
  181. valuesets/schema/clinical/phenopackets.yaml +429 -0
  182. valuesets/schema/computing/file_formats.yaml +631 -0
  183. valuesets/schema/computing/maturity_levels.yaml +229 -0
  184. valuesets/schema/computing/mime_types.yaml +266 -0
  185. valuesets/schema/confidence_levels.yaml +206 -0
  186. valuesets/schema/contributor.yaml +30 -0
  187. valuesets/schema/core.yaml +55 -0
  188. valuesets/schema/data/data_absent_reason.yaml +82 -0
  189. valuesets/schema/data_science/binary_classification.yaml +125 -0
  190. valuesets/schema/data_science/emotion_classification.yaml +109 -0
  191. valuesets/schema/data_science/priority_severity.yaml +122 -0
  192. valuesets/schema/data_science/quality_control.yaml +68 -0
  193. valuesets/schema/data_science/sentiment_analysis.yaml +81 -0
  194. valuesets/schema/data_science/text_classification.yaml +135 -0
  195. valuesets/schema/demographics.yaml +238 -0
  196. valuesets/schema/ecological_interactions.yaml +298 -0
  197. valuesets/schema/energy/energy.yaml +595 -0
  198. valuesets/schema/energy/fossil_fuels.yaml +28 -0
  199. valuesets/schema/energy/nuclear/nuclear_facilities.yaml +463 -0
  200. valuesets/schema/energy/nuclear/nuclear_fuel_cycle.yaml +82 -0
  201. valuesets/schema/energy/nuclear/nuclear_fuels.yaml +421 -0
  202. valuesets/schema/energy/nuclear/nuclear_operations.yaml +480 -0
  203. valuesets/schema/energy/nuclear/nuclear_regulatory.yaml +200 -0
  204. valuesets/schema/energy/nuclear/nuclear_safety.yaml +352 -0
  205. valuesets/schema/energy/nuclear/nuclear_waste.yaml +332 -0
  206. valuesets/schema/energy/nuclear/reactor_types.yaml +394 -0
  207. valuesets/schema/environmental_health/exposures.yaml +355 -0
  208. valuesets/schema/generated_slots.yaml +1828 -0
  209. valuesets/schema/geography/geographic_codes.yaml +1018 -0
  210. valuesets/schema/health/vaccination.yaml +102 -0
  211. valuesets/schema/health.yaml +38 -0
  212. valuesets/schema/healthcare.yaml +53 -0
  213. valuesets/schema/industry/extractive_industry.yaml +89 -0
  214. valuesets/schema/industry/mining.yaml +888 -0
  215. valuesets/schema/industry/safety_colors.yaml +375 -0
  216. valuesets/schema/investigation.yaml +64 -0
  217. valuesets/schema/materials_science/characterization_methods.yaml +193 -0
  218. valuesets/schema/materials_science/crystal_structures.yaml +138 -0
  219. valuesets/schema/materials_science/material_properties.yaml +135 -0
  220. valuesets/schema/materials_science/material_types.yaml +151 -0
  221. valuesets/schema/materials_science/pigments_dyes.yaml +465 -0
  222. valuesets/schema/materials_science/synthesis_methods.yaml +186 -0
  223. valuesets/schema/medical/clinical.yaml +610 -0
  224. valuesets/schema/medical/neuroimaging.yaml +325 -0
  225. valuesets/schema/mining_processing.yaml +295 -0
  226. valuesets/schema/physics/states_of_matter.yaml +46 -0
  227. valuesets/schema/slot_mixins.yaml +143 -0
  228. valuesets/schema/social/person_status.yaml +28 -0
  229. valuesets/schema/spatial/spatial_qualifiers.yaml +466 -0
  230. valuesets/schema/statistics/prediction_outcomes.yaml +26 -0
  231. valuesets/schema/statistics.yaml +34 -0
  232. valuesets/schema/time/temporal.yaml +435 -0
  233. valuesets/schema/types.yaml +15 -0
  234. valuesets/schema/units/measurements.yaml +675 -0
  235. valuesets/schema/valuesets.yaml +100 -0
  236. valuesets/schema/visual/colors.yaml +778 -0
  237. valuesets/utils/__init__.py +6 -0
  238. valuesets/utils/comparison.py +102 -0
  239. valuesets/utils/expand_dynamic_enums.py +414 -0
  240. valuesets/utils/mapping_utils.py +236 -0
  241. valuesets/validators/__init__.py +11 -0
  242. valuesets/validators/enum_evaluator.py +669 -0
  243. valuesets/validators/oak_config.yaml +70 -0
  244. valuesets/validators/validate_with_ols.py +241 -0
  245. valuesets-0.3.1.dist-info/METADATA +395 -0
  246. valuesets-0.3.1.dist-info/RECORD +248 -0
  247. valuesets-0.3.1.dist-info/WHEEL +4 -0
  248. valuesets-0.3.1.dist-info/licenses/LICENSE +201 -0
@@ -0,0 +1,151 @@
1
+ """
2
+ Ecological Interactions Value Sets
3
+
4
+ Value sets for ecological and biological interactions, based on the Relations Ontology (RO) biotically interacts with (RO:0002437) hierarchy.
5
+
6
+
7
+ Generated from: ecological_interactions.yaml
8
+ """
9
+
10
+ from __future__ import annotations
11
+
12
+ from typing import Dict, Any, Optional
13
+ from valuesets.generators.rich_enum import RichEnum
14
+
15
+ class RelativeTimeEnum(RichEnum):
16
+ # Enum members
17
+ BEFORE = "BEFORE"
18
+ AFTER = "AFTER"
19
+ AT_SAME_TIME_AS = "AT_SAME_TIME_AS"
20
+
21
+ # Set metadata after class creation
22
+ RelativeTimeEnum._metadata = {
23
+ }
24
+
25
+ class PresenceEnum(RichEnum):
26
+ # Enum members
27
+ PRESENT = "PRESENT"
28
+ ABSENT = "ABSENT"
29
+ BELOW_DETECTION_LIMIT = "BELOW_DETECTION_LIMIT"
30
+ ABOVE_DETECTION_LIMIT = "ABOVE_DETECTION_LIMIT"
31
+
32
+ # Set metadata after class creation
33
+ PresenceEnum._metadata = {
34
+ "PRESENT": {'description': 'The entity is present'},
35
+ "ABSENT": {'description': 'The entity is absent'},
36
+ "BELOW_DETECTION_LIMIT": {'description': 'The entity is below the detection limit'},
37
+ "ABOVE_DETECTION_LIMIT": {'description': 'The entity is above the detection limit'},
38
+ }
39
+
40
+ class BioticInteractionType(RichEnum):
41
+ """
42
+ Types of biotic interactions between organisms, based on RO:0002437 (biotically interacts with). These represent ecological relationships where at least one partner is an organism.
43
+
44
+ """
45
+ # Enum members
46
+ BIOTICALLY_INTERACTS_WITH = "BIOTICALLY_INTERACTS_WITH"
47
+ TROPHICALLY_INTERACTS_WITH = "TROPHICALLY_INTERACTS_WITH"
48
+ PREYS_ON = "PREYS_ON"
49
+ PREYED_UPON_BY = "PREYED_UPON_BY"
50
+ EATS = "EATS"
51
+ IS_EATEN_BY = "IS_EATEN_BY"
52
+ ACQUIRES_NUTRIENTS_FROM = "ACQUIRES_NUTRIENTS_FROM"
53
+ PROVIDES_NUTRIENTS_FOR = "PROVIDES_NUTRIENTS_FOR"
54
+ SYMBIOTICALLY_INTERACTS_WITH = "SYMBIOTICALLY_INTERACTS_WITH"
55
+ COMMENSUALLY_INTERACTS_WITH = "COMMENSUALLY_INTERACTS_WITH"
56
+ MUTUALISTICALLY_INTERACTS_WITH = "MUTUALISTICALLY_INTERACTS_WITH"
57
+ INTERACTS_VIA_PARASITE_HOST = "INTERACTS_VIA_PARASITE_HOST"
58
+ SYMBIOTROPHICALLY_INTERACTS_WITH = "SYMBIOTROPHICALLY_INTERACTS_WITH"
59
+ PARASITE_OF = "PARASITE_OF"
60
+ HOST_OF = "HOST_OF"
61
+ HAS_HOST = "HAS_HOST"
62
+ PARASITOID_OF = "PARASITOID_OF"
63
+ ECTOPARASITE_OF = "ECTOPARASITE_OF"
64
+ ENDOPARASITE_OF = "ENDOPARASITE_OF"
65
+ INTRACELLULAR_ENDOPARASITE_OF = "INTRACELLULAR_ENDOPARASITE_OF"
66
+ INTERCELLULAR_ENDOPARASITE_OF = "INTERCELLULAR_ENDOPARASITE_OF"
67
+ HEMIPARASITE_OF = "HEMIPARASITE_OF"
68
+ STEM_PARASITE_OF = "STEM_PARASITE_OF"
69
+ ROOT_PARASITE_OF = "ROOT_PARASITE_OF"
70
+ OBLIGATE_PARASITE_OF = "OBLIGATE_PARASITE_OF"
71
+ FACULTATIVE_PARASITE_OF = "FACULTATIVE_PARASITE_OF"
72
+ TROPHIC_PARASITE_OF = "TROPHIC_PARASITE_OF"
73
+ PATHOGEN_OF = "PATHOGEN_OF"
74
+ HAS_PATHOGEN = "HAS_PATHOGEN"
75
+ RESERVOIR_HOST_OF = "RESERVOIR_HOST_OF"
76
+ HAS_RESERVOIR_HOST = "HAS_RESERVOIR_HOST"
77
+ IS_VECTOR_FOR = "IS_VECTOR_FOR"
78
+ POLLINATES = "POLLINATES"
79
+ PARTICIPATES_IN_ABIOTIC_BIOTIC_INTERACTION_WITH = "PARTICIPATES_IN_ABIOTIC_BIOTIC_INTERACTION_WITH"
80
+ ECOLOGICALLY_CO_OCCURS_WITH = "ECOLOGICALLY_CO_OCCURS_WITH"
81
+ HYPERPARASITE_OF = "HYPERPARASITE_OF"
82
+ MESOPARASITE_OF = "MESOPARASITE_OF"
83
+ KLEPTOPARASITE_OF = "KLEPTOPARASITE_OF"
84
+ EPIPHYTE_OF = "EPIPHYTE_OF"
85
+ ALLELOPATH_OF = "ALLELOPATH_OF"
86
+ VISITS = "VISITS"
87
+ VISITS_FLOWERS_OF = "VISITS_FLOWERS_OF"
88
+ HAS_FLOWERS_VISITED_BY = "HAS_FLOWERS_VISITED_BY"
89
+ LAYS_EGGS_IN = "LAYS_EGGS_IN"
90
+ HAS_EGGS_LAID_IN_BY = "HAS_EGGS_LAID_IN_BY"
91
+ LAYS_EGGS_ON = "LAYS_EGGS_ON"
92
+ HAS_EGGS_LAID_ON_BY = "HAS_EGGS_LAID_ON_BY"
93
+ CREATES_HABITAT_FOR = "CREATES_HABITAT_FOR"
94
+
95
+ # Set metadata after class creation
96
+ BioticInteractionType._metadata = {
97
+ "BIOTICALLY_INTERACTS_WITH": {'description': 'An interaction relationship in which at least one of the partners is an organism and the other is either an organism or an abiotic entity with which the organism interacts.\n', 'meaning': 'RO:0002437'},
98
+ "TROPHICALLY_INTERACTS_WITH": {'description': 'An interaction relationship in which the partners are related via a feeding relationship.', 'meaning': 'RO:0002438'},
99
+ "PREYS_ON": {'description': 'An interaction relationship involving a predation process, where the subject kills the target in order to eat it or to feed to siblings, offspring or group members.\n', 'meaning': 'RO:0002439'},
100
+ "PREYED_UPON_BY": {'description': 'Inverse of preys on', 'meaning': 'RO:0002458'},
101
+ "EATS": {'description': 'A biotic interaction where one organism consumes a material entity through a type of mouth or other oral opening.\n', 'meaning': 'RO:0002470'},
102
+ "IS_EATEN_BY": {'description': 'Inverse of eats', 'meaning': 'RO:0002471'},
103
+ "ACQUIRES_NUTRIENTS_FROM": {'description': 'Inverse of provides nutrients for', 'meaning': 'RO:0002457'},
104
+ "PROVIDES_NUTRIENTS_FOR": {'description': 'A biotic interaction where a material entity provides nutrition for an organism.', 'meaning': 'RO:0002469'},
105
+ "SYMBIOTICALLY_INTERACTS_WITH": {'description': 'A biotic interaction in which the two organisms live together in more or less intimate association.\n', 'meaning': 'RO:0002440'},
106
+ "COMMENSUALLY_INTERACTS_WITH": {'description': 'An interaction relationship between two organisms living together in more or less intimate association in a relationship in which one benefits and the other is unaffected.\n', 'meaning': 'RO:0002441'},
107
+ "MUTUALISTICALLY_INTERACTS_WITH": {'description': 'An interaction relationship between two organisms living together in more or less intimate association in a relationship in which both organisms benefit from each other.\n', 'meaning': 'RO:0002442'},
108
+ "INTERACTS_VIA_PARASITE_HOST": {'description': 'An interaction relationship between two organisms living together in more or less intimate association in a relationship in which association is disadvantageous or destructive to one of the organisms.\n', 'meaning': 'RO:0002443'},
109
+ "SYMBIOTROPHICALLY_INTERACTS_WITH": {'description': 'A trophic interaction in which one organism acquires nutrients through a symbiotic relationship with another organism.\n', 'meaning': 'RO:0008510'},
110
+ "PARASITE_OF": {'description': 'A parasite-host relationship where an organism benefits at the expense of another.', 'meaning': 'RO:0002444'},
111
+ "HOST_OF": {'description': 'Inverse of has host', 'meaning': 'RO:0002453'},
112
+ "HAS_HOST": {'description': "X 'has host' y if and only if: x is an organism, y is an organism, and x can live on the surface of or within the body of y.\n", 'meaning': 'RO:0002454'},
113
+ "PARASITOID_OF": {'description': 'A parasite that kills or sterilizes its host', 'meaning': 'RO:0002208'},
114
+ "ECTOPARASITE_OF": {'description': 'A sub-relation of parasite-of in which the parasite lives on or in the integumental system of the host.\n', 'meaning': 'RO:0002632'},
115
+ "ENDOPARASITE_OF": {'description': 'A parasite that lives inside its host', 'meaning': 'RO:0002634'},
116
+ "INTRACELLULAR_ENDOPARASITE_OF": {'description': 'A sub-relation of endoparasite-of in which the parasite inhabits host cells.', 'meaning': 'RO:0002640'},
117
+ "INTERCELLULAR_ENDOPARASITE_OF": {'description': 'A sub-relation of endoparasite-of in which the parasite inhabits the spaces between host cells.\n', 'meaning': 'RO:0002638'},
118
+ "HEMIPARASITE_OF": {'description': 'A sub-relation of parasite-of in which the parasite is a plant, and the parasite is parasitic under natural conditions and is also photosynthetic to some degree.\n', 'meaning': 'RO:0002237'},
119
+ "STEM_PARASITE_OF": {'description': 'A parasite-of relationship in which the host is a plant and the parasite that attaches to the host stem.\n', 'meaning': 'RO:0002235'},
120
+ "ROOT_PARASITE_OF": {'description': 'A parasite-of relationship in which the host is a plant and the parasite that attaches to the host root.\n', 'meaning': 'RO:0002236'},
121
+ "OBLIGATE_PARASITE_OF": {'description': 'A sub-relation of parasite-of in which the parasite that cannot complete its life cycle without a host.\n', 'meaning': 'RO:0002227'},
122
+ "FACULTATIVE_PARASITE_OF": {'description': 'A sub-relations of parasite-of in which the parasite that can complete its life cycle independent of a host.\n', 'meaning': 'RO:0002228'},
123
+ "TROPHIC_PARASITE_OF": {'description': 'A symbiotrophic interaction in which one organism acquires nutrients through a parasitic relationship with another organism.\n', 'meaning': 'RO:0008511'},
124
+ "PATHOGEN_OF": {'description': 'Inverse of has pathogen', 'meaning': 'RO:0002556'},
125
+ "HAS_PATHOGEN": {'description': 'A host interaction where the smaller of the two members of a symbiosis causes a disease in the larger member.\n', 'meaning': 'RO:0002557'},
126
+ "RESERVOIR_HOST_OF": {'description': 'A relation between a host organism and a hosted organism in which the hosted organism naturally occurs in an indefinitely maintained reservoir provided by the host.\n', 'meaning': 'RO:0002802'},
127
+ "HAS_RESERVOIR_HOST": {'description': 'Inverse of reservoir host of', 'meaning': 'RO:0002803'},
128
+ "IS_VECTOR_FOR": {'description': 'Organism acts as a vector for transmitting another organism', 'meaning': 'RO:0002459'},
129
+ "POLLINATES": {'description': 'An interaction where an organism transfers pollen to a plant', 'meaning': 'RO:0002455'},
130
+ "PARTICIPATES_IN_ABIOTIC_BIOTIC_INTERACTION_WITH": {'description': 'A biotic interaction relationship in which one partner is an organism and the other partner is inorganic. For example, the relationship between a sponge and the substrate to which is it anchored.\n', 'meaning': 'RO:0002446'},
131
+ "ECOLOGICALLY_CO_OCCURS_WITH": {'description': 'An interaction relationship describing organisms that often occur together at the same time and space or in the same environment.\n', 'meaning': 'RO:0008506'},
132
+ "HYPERPARASITE_OF": {'description': 'x is a hyperparasite of y iff x is a parasite of a parasite of the target organism y', 'meaning': 'RO:0002553'},
133
+ "MESOPARASITE_OF": {'description': 'A sub-relation of parasite-of in which the parasite is partially an endoparasite and partially an ectoparasite.\n', 'meaning': 'RO:0002636'},
134
+ "KLEPTOPARASITE_OF": {'description': 'A sub-relation of parasite of in which a parasite steals resources from another organism, usually food or nest material.\n', 'meaning': 'RO:0008503'},
135
+ "EPIPHYTE_OF": {'description': 'An interaction relationship wherein a plant or algae is living on the outside surface of another plant.\n', 'meaning': 'RO:0008501'},
136
+ "ALLELOPATH_OF": {'description': 'A relationship between organisms where one organism is influenced by the biochemicals produced by another. Allelopathy is a phenomenon in which one organism releases chemicals to positively or negatively influence the growth, survival or reproduction of other organisms in its vicinity.\n', 'meaning': 'RO:0002555'},
137
+ "VISITS": {'description': 'An interaction where an organism visits another organism or location', 'meaning': 'RO:0002618'},
138
+ "VISITS_FLOWERS_OF": {'description': 'An interaction where an organism visits the flowers of a plant', 'meaning': 'RO:0002622'},
139
+ "HAS_FLOWERS_VISITED_BY": {'description': 'Inverse of visits flowers of', 'meaning': 'RO:0002623'},
140
+ "LAYS_EGGS_IN": {'description': 'An interaction where an organism deposits eggs inside another organism', 'meaning': 'RO:0002624'},
141
+ "HAS_EGGS_LAID_IN_BY": {'description': 'Inverse of lays eggs in', 'meaning': 'RO:0002625'},
142
+ "LAYS_EGGS_ON": {'description': 'An interaction relationship in which organism a lays eggs on the outside surface of organism b. Organism b is neither helped nor harmed in the process of egg laying or incubation.\n', 'meaning': 'RO:0008507'},
143
+ "HAS_EGGS_LAID_ON_BY": {'description': 'Inverse of lays eggs on', 'meaning': 'RO:0008508'},
144
+ "CREATES_HABITAT_FOR": {'description': 'An interaction relationship wherein one organism creates a structure or environment that is lived in by another organism.\n', 'meaning': 'RO:0008505'},
145
+ }
146
+
147
+ __all__ = [
148
+ "RelativeTimeEnum",
149
+ "PresenceEnum",
150
+ "BioticInteractionType",
151
+ ]
@@ -0,0 +1 @@
1
+ """Auto-generated package."""
@@ -0,0 +1,343 @@
1
+ """
2
+ Energy and Power Value Sets
3
+
4
+ Value sets for energy sources, units, consumption, and related concepts
5
+
6
+ Generated from: energy/energy.yaml
7
+ """
8
+
9
+ from __future__ import annotations
10
+
11
+ from typing import Dict, Any, Optional
12
+ from valuesets.generators.rich_enum import RichEnum
13
+
14
+ class EnergySource(RichEnum):
15
+ """
16
+ Types of energy sources and generation methods
17
+ """
18
+ # Enum members
19
+ SOLAR = "SOLAR"
20
+ WIND = "WIND"
21
+ HYDROELECTRIC = "HYDROELECTRIC"
22
+ GEOTHERMAL = "GEOTHERMAL"
23
+ BIOMASS = "BIOMASS"
24
+ BIOFUEL = "BIOFUEL"
25
+ TIDAL = "TIDAL"
26
+ HYDROGEN = "HYDROGEN"
27
+ COAL = "COAL"
28
+ NATURAL_GAS = "NATURAL_GAS"
29
+ PETROLEUM = "PETROLEUM"
30
+ DIESEL = "DIESEL"
31
+ GASOLINE = "GASOLINE"
32
+ PROPANE = "PROPANE"
33
+ NUCLEAR_FISSION = "NUCLEAR_FISSION"
34
+ NUCLEAR_FUSION = "NUCLEAR_FUSION"
35
+ GRID_MIX = "GRID_MIX"
36
+ BATTERY_STORAGE = "BATTERY_STORAGE"
37
+
38
+ # Set metadata after class creation
39
+ EnergySource._metadata = {
40
+ "SOLAR": {'meaning': 'ENVO:01001862', 'annotations': {'renewable': True, 'emission_free': True}, 'aliases': ['Solar radiation']},
41
+ "WIND": {'annotations': {'renewable': True, 'emission_free': True}, 'aliases': ['wind wave energy']},
42
+ "HYDROELECTRIC": {'annotations': {'renewable': True, 'emission_free': True}, 'aliases': ['hydroelectric dam']},
43
+ "GEOTHERMAL": {'meaning': 'ENVO:2000034', 'annotations': {'renewable': True, 'emission_free': True}, 'aliases': ['geothermal energy']},
44
+ "BIOMASS": {'annotations': {'renewable': True, 'emission_free': False}, 'aliases': ['organic material']},
45
+ "BIOFUEL": {'annotations': {'renewable': True, 'emission_free': False}},
46
+ "TIDAL": {'annotations': {'renewable': True, 'emission_free': True}},
47
+ "HYDROGEN": {'meaning': 'CHEBI:18276', 'annotations': {'renewable': 'depends', 'emission_free': True}, 'aliases': ['dihydrogen']},
48
+ "COAL": {'meaning': 'ENVO:02000091', 'annotations': {'renewable': False, 'emission_free': False, 'fossil_fuel': True}},
49
+ "NATURAL_GAS": {'meaning': 'ENVO:01000552', 'annotations': {'renewable': False, 'emission_free': False, 'fossil_fuel': True}},
50
+ "PETROLEUM": {'meaning': 'ENVO:00002984', 'annotations': {'renewable': False, 'emission_free': False, 'fossil_fuel': True}},
51
+ "DIESEL": {'meaning': 'ENVO:03510006', 'annotations': {'renewable': False, 'emission_free': False, 'fossil_fuel': True}, 'aliases': ['diesel fuel']},
52
+ "GASOLINE": {'annotations': {'renewable': False, 'emission_free': False, 'fossil_fuel': True}, 'aliases': ['fuel oil']},
53
+ "PROPANE": {'meaning': 'ENVO:01000553', 'annotations': {'renewable': False, 'emission_free': False, 'fossil_fuel': True}, 'aliases': ['liquefied petroleum gas']},
54
+ "NUCLEAR_FISSION": {'annotations': {'renewable': False, 'emission_free': True}, 'aliases': ['nuclear energy']},
55
+ "NUCLEAR_FUSION": {'annotations': {'renewable': False, 'emission_free': True}, 'aliases': ['nuclear energy']},
56
+ "GRID_MIX": {'annotations': {'renewable': 'partial'}},
57
+ "BATTERY_STORAGE": {'description': 'Battery storage systems', 'annotations': {'storage': True}},
58
+ }
59
+
60
+ class EnergyUnit(RichEnum):
61
+ """
62
+ Units for measuring energy
63
+ """
64
+ # Enum members
65
+ JOULE = "JOULE"
66
+ KILOJOULE = "KILOJOULE"
67
+ MEGAJOULE = "MEGAJOULE"
68
+ GIGAJOULE = "GIGAJOULE"
69
+ WATT_HOUR = "WATT_HOUR"
70
+ KILOWATT_HOUR = "KILOWATT_HOUR"
71
+ MEGAWATT_HOUR = "MEGAWATT_HOUR"
72
+ GIGAWATT_HOUR = "GIGAWATT_HOUR"
73
+ TERAWATT_HOUR = "TERAWATT_HOUR"
74
+ CALORIE = "CALORIE"
75
+ KILOCALORIE = "KILOCALORIE"
76
+ BTU = "BTU"
77
+ THERM = "THERM"
78
+ ELECTRON_VOLT = "ELECTRON_VOLT"
79
+ TOE = "TOE"
80
+ TCE = "TCE"
81
+
82
+ # Set metadata after class creation
83
+ EnergyUnit._metadata = {
84
+ "JOULE": {'description': 'Joule (J)', 'meaning': 'QUDT:J', 'annotations': {'symbol': 'J', 'ucum': 'J', 'si_base': True}},
85
+ "KILOJOULE": {'description': 'Kilojoule (kJ)', 'meaning': 'QUDT:KiloJ', 'annotations': {'symbol': 'kJ', 'ucum': 'kJ', 'joules': 1000}},
86
+ "MEGAJOULE": {'description': 'Megajoule (MJ)', 'meaning': 'QUDT:MegaJ', 'annotations': {'symbol': 'MJ', 'ucum': 'MJ', 'joules': '1e6'}},
87
+ "GIGAJOULE": {'description': 'Gigajoule (GJ)', 'meaning': 'QUDT:GigaJ', 'annotations': {'symbol': 'GJ', 'ucum': 'GJ', 'joules': '1e9'}},
88
+ "WATT_HOUR": {'description': 'Watt-hour (Wh)', 'meaning': 'QUDT:W-HR', 'annotations': {'symbol': 'Wh', 'ucum': 'W.h', 'joules': 3600}},
89
+ "KILOWATT_HOUR": {'description': 'Kilowatt-hour (kWh)', 'meaning': 'QUDT:KiloW-HR', 'annotations': {'symbol': 'kWh', 'ucum': 'kW.h', 'joules': '3.6e6'}},
90
+ "MEGAWATT_HOUR": {'description': 'Megawatt-hour (MWh)', 'meaning': 'QUDT:MegaW-HR', 'annotations': {'symbol': 'MWh', 'ucum': 'MW.h', 'joules': '3.6e9'}},
91
+ "GIGAWATT_HOUR": {'description': 'Gigawatt-hour (GWh)', 'meaning': 'QUDT:GigaW-HR', 'annotations': {'symbol': 'GWh', 'ucum': 'GW.h', 'joules': '3.6e12'}},
92
+ "TERAWATT_HOUR": {'description': 'Terawatt-hour (TWh)', 'meaning': 'QUDT:TeraW-HR', 'annotations': {'symbol': 'TWh', 'ucum': 'TW.h', 'joules': '3.6e15'}},
93
+ "CALORIE": {'description': 'Calorie (cal)', 'meaning': 'QUDT:CAL', 'annotations': {'symbol': 'cal', 'ucum': 'cal', 'joules': 4.184}},
94
+ "KILOCALORIE": {'description': 'Kilocalorie (kcal)', 'meaning': 'QUDT:KiloCAL', 'annotations': {'symbol': 'kcal', 'ucum': 'kcal', 'joules': 4184}},
95
+ "BTU": {'description': 'British thermal unit', 'meaning': 'QUDT:BTU_IT', 'annotations': {'symbol': 'BTU', 'ucum': '[Btu_IT]', 'joules': 1055.06}},
96
+ "THERM": {'description': 'Therm', 'meaning': 'QUDT:THM_US', 'annotations': {'symbol': 'thm', 'ucum': '[thm_us]', 'joules': '1.055e8'}},
97
+ "ELECTRON_VOLT": {'description': 'Electron volt (eV)', 'meaning': 'QUDT:EV', 'annotations': {'symbol': 'eV', 'ucum': 'eV', 'joules': 1.602e-19}},
98
+ "TOE": {'description': 'Tonne of oil equivalent', 'meaning': 'QUDT:TOE', 'annotations': {'symbol': 'toe', 'ucum': 'toe', 'joules': '4.187e10'}},
99
+ "TCE": {'description': 'Tonne of coal equivalent', 'annotations': {'symbol': 'tce', 'ucum': 'tce', 'joules': '2.93e10'}},
100
+ }
101
+
102
+ class PowerUnit(RichEnum):
103
+ """
104
+ Units for measuring power (energy per time)
105
+ """
106
+ # Enum members
107
+ WATT = "WATT"
108
+ KILOWATT = "KILOWATT"
109
+ MEGAWATT = "MEGAWATT"
110
+ GIGAWATT = "GIGAWATT"
111
+ TERAWATT = "TERAWATT"
112
+ HORSEPOWER = "HORSEPOWER"
113
+ BTU_PER_HOUR = "BTU_PER_HOUR"
114
+
115
+ # Set metadata after class creation
116
+ PowerUnit._metadata = {
117
+ "WATT": {'description': 'Watt (W)', 'meaning': 'QUDT:W', 'annotations': {'symbol': 'W', 'ucum': 'W', 'si_base': True}},
118
+ "KILOWATT": {'description': 'Kilowatt (kW)', 'meaning': 'QUDT:KiloW', 'annotations': {'symbol': 'kW', 'ucum': 'kW', 'watts': 1000}},
119
+ "MEGAWATT": {'description': 'Megawatt (MW)', 'meaning': 'QUDT:MegaW', 'annotations': {'symbol': 'MW', 'ucum': 'MW', 'watts': '1e6'}},
120
+ "GIGAWATT": {'description': 'Gigawatt (GW)', 'meaning': 'QUDT:GigaW', 'annotations': {'symbol': 'GW', 'ucum': 'GW', 'watts': '1e9'}},
121
+ "TERAWATT": {'description': 'Terawatt (TW)', 'meaning': 'QUDT:TeraW', 'annotations': {'symbol': 'TW', 'ucum': 'TW', 'watts': '1e12'}},
122
+ "HORSEPOWER": {'description': 'Horsepower', 'meaning': 'QUDT:HP', 'annotations': {'symbol': 'hp', 'ucum': '[HP]', 'watts': 745.7}},
123
+ "BTU_PER_HOUR": {'description': 'BTU per hour', 'annotations': {'symbol': 'BTU/h', 'ucum': '[Btu_IT]/h', 'watts': 0.293}},
124
+ }
125
+
126
+ class EnergyEfficiencyRating(RichEnum):
127
+ """
128
+ Energy efficiency ratings and standards
129
+ """
130
+ # Enum members
131
+ A_PLUS_PLUS_PLUS = "A_PLUS_PLUS_PLUS"
132
+ A_PLUS_PLUS = "A_PLUS_PLUS"
133
+ A_PLUS = "A_PLUS"
134
+ A = "A"
135
+ B = "B"
136
+ C = "C"
137
+ D = "D"
138
+ E = "E"
139
+ F = "F"
140
+ G = "G"
141
+ ENERGY_STAR = "ENERGY_STAR"
142
+ ENERGY_STAR_MOST_EFFICIENT = "ENERGY_STAR_MOST_EFFICIENT"
143
+
144
+ # Set metadata after class creation
145
+ EnergyEfficiencyRating._metadata = {
146
+ "A_PLUS_PLUS_PLUS": {'description': 'A+++ (highest efficiency)', 'annotations': {'rank': 1, 'region': 'EU'}},
147
+ "A_PLUS_PLUS": {'description': 'A++', 'annotations': {'rank': 2, 'region': 'EU'}},
148
+ "A_PLUS": {'description': 'A+', 'annotations': {'rank': 3, 'region': 'EU'}},
149
+ "A": {'description': 'A', 'annotations': {'rank': 4, 'region': 'EU'}},
150
+ "B": {'description': 'B', 'annotations': {'rank': 5, 'region': 'EU'}},
151
+ "C": {'description': 'C', 'annotations': {'rank': 6, 'region': 'EU'}},
152
+ "D": {'description': 'D', 'annotations': {'rank': 7, 'region': 'EU'}},
153
+ "E": {'description': 'E', 'annotations': {'rank': 8, 'region': 'EU'}},
154
+ "F": {'description': 'F', 'annotations': {'rank': 9, 'region': 'EU'}},
155
+ "G": {'description': 'G (lowest efficiency)', 'annotations': {'rank': 10, 'region': 'EU'}},
156
+ "ENERGY_STAR": {'description': 'Energy Star certified', 'annotations': {'region': 'US'}},
157
+ "ENERGY_STAR_MOST_EFFICIENT": {'description': 'Energy Star Most Efficient', 'annotations': {'region': 'US'}},
158
+ }
159
+
160
+ class BuildingEnergyStandard(RichEnum):
161
+ """
162
+ Building energy efficiency standards and certifications
163
+ """
164
+ # Enum members
165
+ PASSIVE_HOUSE = "PASSIVE_HOUSE"
166
+ LEED_PLATINUM = "LEED_PLATINUM"
167
+ LEED_GOLD = "LEED_GOLD"
168
+ LEED_SILVER = "LEED_SILVER"
169
+ LEED_CERTIFIED = "LEED_CERTIFIED"
170
+ BREEAM_OUTSTANDING = "BREEAM_OUTSTANDING"
171
+ BREEAM_EXCELLENT = "BREEAM_EXCELLENT"
172
+ BREEAM_VERY_GOOD = "BREEAM_VERY_GOOD"
173
+ BREEAM_GOOD = "BREEAM_GOOD"
174
+ BREEAM_PASS = "BREEAM_PASS"
175
+ NET_ZERO = "NET_ZERO"
176
+ ENERGY_POSITIVE = "ENERGY_POSITIVE"
177
+ ZERO_CARBON = "ZERO_CARBON"
178
+
179
+ # Set metadata after class creation
180
+ BuildingEnergyStandard._metadata = {
181
+ "PASSIVE_HOUSE": {'description': 'Passive House (Passivhaus) standard'},
182
+ "LEED_PLATINUM": {'description': 'LEED Platinum certification'},
183
+ "LEED_GOLD": {'description': 'LEED Gold certification'},
184
+ "LEED_SILVER": {'description': 'LEED Silver certification'},
185
+ "LEED_CERTIFIED": {'description': 'LEED Certified'},
186
+ "BREEAM_OUTSTANDING": {'description': 'BREEAM Outstanding'},
187
+ "BREEAM_EXCELLENT": {'description': 'BREEAM Excellent'},
188
+ "BREEAM_VERY_GOOD": {'description': 'BREEAM Very Good'},
189
+ "BREEAM_GOOD": {'description': 'BREEAM Good'},
190
+ "BREEAM_PASS": {'description': 'BREEAM Pass'},
191
+ "NET_ZERO": {'description': 'Net Zero Energy Building'},
192
+ "ENERGY_POSITIVE": {'description': 'Energy Positive Building'},
193
+ "ZERO_CARBON": {'description': 'Zero Carbon Building'},
194
+ }
195
+
196
+ class GridType(RichEnum):
197
+ """
198
+ Types of electrical grid systems
199
+ """
200
+ # Enum members
201
+ MAIN_GRID = "MAIN_GRID"
202
+ MICROGRID = "MICROGRID"
203
+ OFF_GRID = "OFF_GRID"
204
+ SMART_GRID = "SMART_GRID"
205
+ MINI_GRID = "MINI_GRID"
206
+ VIRTUAL_POWER_PLANT = "VIRTUAL_POWER_PLANT"
207
+
208
+ # Set metadata after class creation
209
+ GridType._metadata = {
210
+ "MAIN_GRID": {'description': 'Main utility grid'},
211
+ "MICROGRID": {'description': 'Microgrid'},
212
+ "OFF_GRID": {'description': 'Off-grid/standalone'},
213
+ "SMART_GRID": {'description': 'Smart grid'},
214
+ "MINI_GRID": {'description': 'Mini-grid'},
215
+ "VIRTUAL_POWER_PLANT": {'description': 'Virtual power plant'},
216
+ }
217
+
218
+ class EnergyStorageType(RichEnum):
219
+ """
220
+ Types of energy storage systems
221
+ """
222
+ # Enum members
223
+ LITHIUM_ION_BATTERY = "LITHIUM_ION_BATTERY"
224
+ LEAD_ACID_BATTERY = "LEAD_ACID_BATTERY"
225
+ FLOW_BATTERY = "FLOW_BATTERY"
226
+ SOLID_STATE_BATTERY = "SOLID_STATE_BATTERY"
227
+ SODIUM_ION_BATTERY = "SODIUM_ION_BATTERY"
228
+ PUMPED_HYDRO = "PUMPED_HYDRO"
229
+ COMPRESSED_AIR = "COMPRESSED_AIR"
230
+ FLYWHEEL = "FLYWHEEL"
231
+ GRAVITY_STORAGE = "GRAVITY_STORAGE"
232
+ MOLTEN_SALT = "MOLTEN_SALT"
233
+ ICE_STORAGE = "ICE_STORAGE"
234
+ PHASE_CHANGE = "PHASE_CHANGE"
235
+ HYDROGEN_STORAGE = "HYDROGEN_STORAGE"
236
+ SYNTHETIC_FUEL = "SYNTHETIC_FUEL"
237
+ SUPERCAPACITOR = "SUPERCAPACITOR"
238
+ SUPERCONDUCTING = "SUPERCONDUCTING"
239
+
240
+ # Set metadata after class creation
241
+ EnergyStorageType._metadata = {
242
+ "LITHIUM_ION_BATTERY": {'description': 'Lithium-ion battery', 'annotations': {'category': 'electrochemical'}},
243
+ "LEAD_ACID_BATTERY": {'description': 'Lead-acid battery', 'annotations': {'category': 'electrochemical'}},
244
+ "FLOW_BATTERY": {'description': 'Flow battery (e.g., vanadium redox)', 'annotations': {'category': 'electrochemical'}},
245
+ "SOLID_STATE_BATTERY": {'description': 'Solid-state battery', 'annotations': {'category': 'electrochemical'}},
246
+ "SODIUM_ION_BATTERY": {'description': 'Sodium-ion battery', 'annotations': {'category': 'electrochemical'}},
247
+ "PUMPED_HYDRO": {'description': 'Pumped hydroelectric storage', 'annotations': {'category': 'mechanical'}},
248
+ "COMPRESSED_AIR": {'description': 'Compressed air energy storage (CAES)', 'annotations': {'category': 'mechanical'}},
249
+ "FLYWHEEL": {'description': 'Flywheel energy storage', 'annotations': {'category': 'mechanical'}},
250
+ "GRAVITY_STORAGE": {'description': 'Gravity-based storage', 'annotations': {'category': 'mechanical'}},
251
+ "MOLTEN_SALT": {'description': 'Molten salt thermal storage', 'annotations': {'category': 'thermal'}},
252
+ "ICE_STORAGE": {'description': 'Ice thermal storage', 'annotations': {'category': 'thermal'}},
253
+ "PHASE_CHANGE": {'description': 'Phase change materials', 'annotations': {'category': 'thermal'}},
254
+ "HYDROGEN_STORAGE": {'description': 'Hydrogen storage', 'annotations': {'category': 'chemical'}},
255
+ "SYNTHETIC_FUEL": {'description': 'Synthetic fuel storage', 'annotations': {'category': 'chemical'}},
256
+ "SUPERCAPACITOR": {'description': 'Supercapacitor', 'annotations': {'category': 'electrical'}},
257
+ "SUPERCONDUCTING": {'description': 'Superconducting magnetic energy storage (SMES)', 'annotations': {'category': 'electrical'}},
258
+ }
259
+
260
+ class EmissionScope(RichEnum):
261
+ """
262
+ Greenhouse gas emission scopes (GHG Protocol)
263
+ """
264
+ # Enum members
265
+ SCOPE_1 = "SCOPE_1"
266
+ SCOPE_2 = "SCOPE_2"
267
+ SCOPE_3 = "SCOPE_3"
268
+ SCOPE_3_UPSTREAM = "SCOPE_3_UPSTREAM"
269
+ SCOPE_3_DOWNSTREAM = "SCOPE_3_DOWNSTREAM"
270
+
271
+ # Set metadata after class creation
272
+ EmissionScope._metadata = {
273
+ "SCOPE_1": {'description': 'Direct emissions from owned or controlled sources', 'annotations': {'ghg_protocol': 'Scope 1'}},
274
+ "SCOPE_2": {'description': 'Indirect emissions from purchased energy', 'annotations': {'ghg_protocol': 'Scope 2'}},
275
+ "SCOPE_3": {'description': 'All other indirect emissions in value chain', 'annotations': {'ghg_protocol': 'Scope 3'}},
276
+ "SCOPE_3_UPSTREAM": {'description': 'Upstream Scope 3 emissions', 'annotations': {'ghg_protocol': 'Scope 3'}},
277
+ "SCOPE_3_DOWNSTREAM": {'description': 'Downstream Scope 3 emissions', 'annotations': {'ghg_protocol': 'Scope 3'}},
278
+ }
279
+
280
+ class CarbonIntensity(RichEnum):
281
+ """
282
+ Carbon intensity levels for energy sources
283
+ """
284
+ # Enum members
285
+ ZERO_CARBON = "ZERO_CARBON"
286
+ VERY_LOW_CARBON = "VERY_LOW_CARBON"
287
+ LOW_CARBON = "LOW_CARBON"
288
+ MEDIUM_CARBON = "MEDIUM_CARBON"
289
+ HIGH_CARBON = "HIGH_CARBON"
290
+ VERY_HIGH_CARBON = "VERY_HIGH_CARBON"
291
+
292
+ # Set metadata after class creation
293
+ CarbonIntensity._metadata = {
294
+ "ZERO_CARBON": {'description': 'Zero carbon emissions', 'annotations': {'gCO2_per_kWh': 0}},
295
+ "VERY_LOW_CARBON": {'description': 'Very low carbon (< 50 gCO2/kWh)', 'annotations': {'gCO2_per_kWh': '0-50'}},
296
+ "LOW_CARBON": {'description': 'Low carbon (50-200 gCO2/kWh)', 'annotations': {'gCO2_per_kWh': '50-200'}},
297
+ "MEDIUM_CARBON": {'description': 'Medium carbon (200-500 gCO2/kWh)', 'annotations': {'gCO2_per_kWh': '200-500'}},
298
+ "HIGH_CARBON": {'description': 'High carbon (500-1000 gCO2/kWh)', 'annotations': {'gCO2_per_kWh': '500-1000'}},
299
+ "VERY_HIGH_CARBON": {'description': 'Very high carbon (> 1000 gCO2/kWh)', 'annotations': {'gCO2_per_kWh': '1000+'}},
300
+ }
301
+
302
+ class ElectricityMarket(RichEnum):
303
+ """
304
+ Types of electricity markets and pricing
305
+ """
306
+ # Enum members
307
+ SPOT_MARKET = "SPOT_MARKET"
308
+ DAY_AHEAD = "DAY_AHEAD"
309
+ INTRADAY = "INTRADAY"
310
+ FUTURES = "FUTURES"
311
+ CAPACITY_MARKET = "CAPACITY_MARKET"
312
+ ANCILLARY_SERVICES = "ANCILLARY_SERVICES"
313
+ BILATERAL = "BILATERAL"
314
+ FEED_IN_TARIFF = "FEED_IN_TARIFF"
315
+ NET_METERING = "NET_METERING"
316
+ POWER_PURCHASE_AGREEMENT = "POWER_PURCHASE_AGREEMENT"
317
+
318
+ # Set metadata after class creation
319
+ ElectricityMarket._metadata = {
320
+ "SPOT_MARKET": {'description': 'Spot market/real-time pricing'},
321
+ "DAY_AHEAD": {'description': 'Day-ahead market'},
322
+ "INTRADAY": {'description': 'Intraday market'},
323
+ "FUTURES": {'description': 'Futures market'},
324
+ "CAPACITY_MARKET": {'description': 'Capacity market'},
325
+ "ANCILLARY_SERVICES": {'description': 'Ancillary services market'},
326
+ "BILATERAL": {'description': 'Bilateral contracts'},
327
+ "FEED_IN_TARIFF": {'description': 'Feed-in tariff'},
328
+ "NET_METERING": {'description': 'Net metering'},
329
+ "POWER_PURCHASE_AGREEMENT": {'description': 'Power purchase agreement (PPA)'},
330
+ }
331
+
332
+ __all__ = [
333
+ "EnergySource",
334
+ "EnergyUnit",
335
+ "PowerUnit",
336
+ "EnergyEfficiencyRating",
337
+ "BuildingEnergyStandard",
338
+ "GridType",
339
+ "EnergyStorageType",
340
+ "EmissionScope",
341
+ "CarbonIntensity",
342
+ "ElectricityMarket",
343
+ ]
@@ -0,0 +1,29 @@
1
+ """
2
+
3
+ Generated from: energy/fossil_fuels.yaml
4
+ """
5
+
6
+ from __future__ import annotations
7
+
8
+ from typing import Dict, Any, Optional
9
+ from valuesets.generators.rich_enum import RichEnum
10
+
11
+ class FossilFuelTypeEnum(RichEnum):
12
+ """
13
+ Types of fossil fuels used for energy generation
14
+ """
15
+ # Enum members
16
+ COAL = "COAL"
17
+ NATURAL_GAS = "NATURAL_GAS"
18
+ PETROLEUM = "PETROLEUM"
19
+
20
+ # Set metadata after class creation
21
+ FossilFuelTypeEnum._metadata = {
22
+ "COAL": {'description': 'Coal', 'meaning': 'ENVO:02000091'},
23
+ "NATURAL_GAS": {'description': 'Natural gas', 'meaning': 'ENVO:01000552'},
24
+ "PETROLEUM": {'description': 'Petroleum', 'meaning': 'ENVO:00002984'},
25
+ }
26
+
27
+ __all__ = [
28
+ "FossilFuelTypeEnum",
29
+ ]
@@ -0,0 +1 @@
1
+ """Auto-generated package."""