This repository defines the structure, terminology, and usage examples for our informational model. It is modular and versioned to support clarity, reuse, and collaborative development.
informational-model/
βββ spec/
β βββ core.md # High-level purpose, scope, and ontology documentation
β βββ repos.md # Descriptions of all GreenEarthX code repositories
β βββ profiles/ # Sector-specific or modular extensions (e.g., hydrogen.md, CCUS.md)
β βββ mappings/ # Field-level data transformation mappings
β βββ data_mapping_spec.md # Specification for mapping raw data to the model
β
βββ vocab/
β βββ terms.csv # Glossary of terms, entities, and relationships
β βββ code_lists/ # Controlled vocabularies (e.g., fuel types, units)
β
βββ architecture/
β βββ geomap-applications-aws-architecture.md # Detailed cloud deployment and security architecture
β
βββ examples/ # JSON-LD / YAML examples showing how to use the model
βββ diagrams/ # Visual diagrams (.drawio, .png) illustrating structure and flow
βββ governance.md # Contribution guidelines, versioning strategy, and change process
βββ Datasets/ # Sample datasets for testing or onboarding use cases
π Key Components
spec/core.md: Describes the overarching goals, scope, and ontology.spec/profiles/: Contains sub-models or extensions (by domain, version, or feature).vocab/terms.csv: A complete glossary of entities and definitions.vocab/code_lists/: Controlled vocabularies and enumerated types.architecture/: Detailed technical documentation of infrastructure and deployment.examples/: Sample JSON-LD or YAML files showing real-world usage.diagrams/: Visual diagrams (.drawio, .png) illustrating the data model.governance.md: Guidelines for versioning, reviewing, and maintaining the model.Datasets/: Structured datasets compliant with the model.
π¦ Repository Overview
For a description of all GreenEarthX repositories and their roles in the system, see spec/repos.md.
To get familiar with the model:
- Start with
spec/core.md. - Browse the profiles for domain-specific modules.
- Refer to
vocab/terms.csvfor definitions. - Explore
examples/for example implementations.
For details on how to contribute or propose changes, see governance.md.
Include licensing and reuse information here if applicable.