Fill out data schema sheet: SAInt Data Model#22
Open
kravitsjacob wants to merge 24 commits intoG-PST:mainfrom
Open
Fill out data schema sheet: SAInt Data Model#22kravitsjacob wants to merge 24 commits intoG-PST:mainfrom
kravitsjacob wants to merge 24 commits intoG-PST:mainfrom
Conversation
…a Model. Encoord is the organization not the software name.
…information, and versioning. Set repository to null and updated documentation link.
…ocumentation links, and enhance references to schema and validation logic.
…ify the model's structure, intended users, and supported modeling domains.
…data captured description, and elaborate on conceptual structure to emphasize graph-based and object-oriented design.
…ptured sections as lists for improved readability and clarity.
…clarify the separation of network structure and scenario assumptions, as well as the distinction between base and derived results for improved usability and flexibility.
…ify schema format and implementation languages, and enhance interoperability details to improve overall clarity and usability.
…the built-in units library, user preferences for input and display, and consistent value conversions across the model for improved usability.
…rity and enhance validation approach description to detail continuous validation processes and error handling during data import.
…ser description for improved clarity on the model's target audience.
…intainer and refine summary description for improved clarity.
…ne the model and eliminate ambiguity regarding decision-making processes.
…ame and date for improved documentation accuracy.
…the lack of direct overlap with other schemas and emphasize the model's focus on multi-energy infrastructure and integrated planning.
…he need for a software-agnostic data schema and explicit translation contracts to support meaningful interoperability across different tools and modeling approaches.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fills out the workshop data schema sheet for the SAInt data model in
data_schemas/saint_data_model.yaml. YAML only, no app code.Naming
The sheet talks about SAInt (the software / data model), not encoord as if it were the schema name. encoord only shows up where it’s actually the org (
identity.organization, maintainer affiliation, that kind of thing).Changes
Identity and links: maintainer + GitHub, version, maturity, and links out to the public schema definition, scenario/timeseries and docs.
Summary and scope: what the model covers (networks, scenarios, solutions), domains, what’s explicitly out of scope (e.g. electric dynamics), and the high-level shape (graph + OO-style specialization).
Design: the main tradeoffs (network vs scenario split, base vs derived results), interoperability and how it relates to other tools, extensibility, units, validation/import behavior. Dropped the governance block and left it
~so the sheet stays readable.Sections 4-6: practical usage (SAInt link, synthetic data note, who uses it, data availability), limitations (IPM / cross-tool pain points), and interoperability (where we overlap other schemas, what real convergence would take, and a short note for other participants).
Also set preparer name and date on the card.
Misc
Normalized line endings to LF and fixed small typos/formatting.
data_schemas/saint_data_model.yamlpasses the repo’s YAML lint (.yamllint.yaml).For issue #15.