Skip to content

GreenEarthX/Information-model

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

19 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“¦ Informational Model

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.


πŸ“ Directory Structure

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

πŸ“˜ 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.

πŸš€ Getting Started


To get familiar with the model:

  1. Start with spec/core.md.
  2. Browse the profiles for domain-specific modules.
  3. Refer to vocab/terms.csv for definitions.
  4. Explore examples/ for example implementations.

πŸ”„ Governance & Contributions

For details on how to contribute or propose changes, see governance.md.


πŸ§ͺ License & Usage

Include licensing and reuse information here if applicable.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published