Migrate to Metanorma template with structured requirements by liangsteve · Pull Request #33 · opengeospatial/EmissionML

liangsteve · 2026-03-02T19:56:42Z

Summary

Migrates the OGC standard document build from raw asciidoctor to Metanorma tooling (Gemfile, Makefile, metanorma.yml, GitHub Actions CI)
Renames entry point from standard_document.adoc to document.adoc (Metanorma convention)
Converts requirements and abstract tests from inline AsciiDoc tables to Metanorma structured format with individual REQ_*.adoc and ATS_*.adoc files
Fixes docsubtype to conceptual-model, updates README.md with Metanorma build instructions
Adds compiled outputs to .gitignore, removes old standard_document.* tracked outputs
Fixes CI deploy condition to support both main and master branches
Includes all prior work on the template-upgrade branch: normative text, definitions, UML diagrams, informative clauses, bibliography, and contributors table

Test plan

Verify metanorma compile document.adoc produces HTML, PDF, DOC, XML without functional errors
Verify requirements and abstract tests render correctly in compiled output
Verify GitHub Actions CI triggers on PR and builds successfully
Review remaining XML validation warnings (keyword format, anchor/id attributes) — these are Metanorma version-specific and non-blocking

🤖 Generated with Claude Code

initialize branch 25-019. Part 1 Data Model

added the standard template instructions

added submitters

added doc number, etc.

Need to change to PlantUML or XMI in the future.

add Mechanism definition

note to "identity, structure, or purpose" The phrase “identity, structure, or purpose” is meant to cover all the ways people might mistakenly bake feature assumptions into mechanisms: • Identity → specific asset (e.g., “compressor”) • Structure → mechanical configuration (e.g., “has rod packing”) • Purpose → functional role (e.g., “storage tank used for condensate”)

… Source Feature and Unit of Measure added definitions, Emission Event, Feature, Measurement, Observation, Source Feature and Unit of Measure

Added latest UML using mermaid format.

feat(emissionml): refactor core model—value-objects for time, evidence-based assertions, and intent via mechanism Summary • Reworked EmissionML class diagram to center on evidence-backed assertions and cleaner separations of concerns. Introduces TemporalBound value object, determination-method hierarchy, and intent derived from Mechanism. Aligns Observation with ISO 19156 and simplifies Event surface. Added • TemporalBound <<ValueObject>> with time: TM_Instant and quality: DQ_Element. • Provenance edges: EmissionQuantity --> Observation : hasEvidence, TemporalBound --> Observation : hasEvidence. • Determination-method hierarchy: AbstractDeterminationMethod (abstract), TemporalDeterminationMethod, QuantityDeterminationMethod. • Observation now explicit (<<ISO 19156:2023>>) with result and time. • EmissionIntent <<CodeList>> with members intentional | unintentional | unknown. • Constraint: SourceFeatureType --> Mechanism : allowedMechanism (“honor system”). • Cardinalities and named roles across associations. Changed • EmissionEvent now composes: • *-- EmissionQuantity : hasQuantity • o-- TemporalBound : startTime / endTime? • --> SourceFeature : hasSource • --> Mechanism : hasMechanism • Intent is no longer a direct attribute of EmissionEvent; it is implied via Mechanism ..> EmissionIntent : hasIntent. • EmissionQuantity now: • *-- UnitOfMeasure : hasUnit • --> QuantityDeterminationMethod : hasDeterminationMethod • Keeps quantity: double, quality: DQ_Element (explicit). • Observation --> SourceFeature : featureOfInterest (renamed from “UltimateFeatureOfInterest”). • SourceFeature --> SourceFeatureType : hasType (role name clarified). Removed • StartEvent, EndEvent, and TemporalBoundEvent (replaced by TemporalBound with composition from EmissionEvent). • DeterminationMethod (replaced by abstract + specific subclasses). • DeterminationType, EmissionEventPattern. • SourceFeature.attributionGranularity, SourceFeature.observations[0..*] (provenance now modeled from the asserting objects). • EmissionEvent.name, direct intent field. Migration notes • Replace EmissionEvent --> StartEvent/EndEvent with: • EmissionEvent o-- TemporalBound : startTime • EmissionEvent o-- TemporalBound : endTime (0..1) • Map TemporalBoundEvent/DeterminationType → TemporalBound --> TemporalDeterminationMethod. • Map EmissionQuantity.quantityDeterminationMethod: URI → EmissionQuantity --> QuantityDeterminationMethod. • Replace SourceFeatureType.mayEmitVia → SourceFeatureType.allowedMechanism. • Update edges/roles: • EmissionEvent.isQuantifiedBy → hasQuantity • Observation.UltimateFeatureOfInterest → featureOfInterest • SourceFeature.hasSourceFeatureType → hasType • Intent handling: remove EmissionEvent.intent; derive via Mechanism ..> EmissionIntent. Rationale • Clarifies provenance (quantities/times cite their observations). • Encapsulates temporal assertions as value objects with quality. • Separates determination semantics for time vs quantity. • Moves intent to mechanism level to reduce duplication and ambiguity. Refs: ISO 19156 (Observation), ISO 19157 (DQ_Element).

latest UML. re: SWG meeting on 2025-12-12

Changes Summary • Data Quality Elements — Cardinality Updated • EmissionQuantity.quality: changed from DQ_Element → DQ_Element[0..*] (line 11) • TemporalBound.quality: changed from DQ_Element → DQ_Element[0..*] (line 21) Impact: both elements can now have zero or multiple quality elements instead of exactly one. • SourceType Class — Re-enabled • Lines 35–38: SourceType class uncommented and fully defined with: • +name: String • +description: String • +definition: URI • Line 80: relationship uncommented: Source "0..*" --> "0..1" SourceType : hasType Impact: SourceType is now an optional part of the model. • Mechanism Class — Expanded Definition • Changed from <<CodeList>> (old line 41) to a full class with attributes (new lines 41–44): • +label: String • +description: String[0..1] • +hasIntent: EmissionIntent Impact: Mechanism is now a proper class with properties, not just a code list reference. • EmissionIntent — Changed from CodeList to Enumeration • Type changed from <<CodeList>> → <<enumeration>> (line 47) • Values standardized to uppercase: • intentional → INTENTIONAL • unintentional → UNINTENTIONAL • unknown → UNKNOWN Impact: EmissionIntent is now an enumeration with standardized values. • DeterminationMethod — Enhanced • Added +description: String[0..1] (line 54) • Changed +definition: URI → +definition: URI[0..1] (line 55) Impact: both description and definition are now optional. Removed Elements • Lines 78–79 (old): removed the commented “Honor System” constraint relationship: %% SourceType "1" --> "0..*" Mechanism : allowedMechanism Impact: this constraint is no longer part of the model, even as a comment.

update the definition of Emission Event.

Add missing Source Type (Req 3) and Emission Intent (Req 9), remove start-time and end-time (relations of Emission Event, not standalone requirements), renumber to match clause_7, and simplify descriptions to single source of truth pattern. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

OM_Observation was the O&M 2.0 class name. OMS 3.0 / ISO/OGC 19156:2023 uses Observation. Updated class references and notes across clause_7, Mermaid diagram, and UML markdown. ISO citation kept as ISO/OGC 19156:2023 (OMS 3.0) for context. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Rendering workflow: Mermaid (.mmd) → PlantUML (.puml) → SVG/PNG. PlantUML polyline routing resolves crowded edge labels for the multiple evidence and basis relationships from EmissionEvent. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Add change notes for evidence/basis lift to EmissionEvent, TemporalBound as true value object, aggregation→composition, and EmissionIntent attribute→relationship. Move ISO alignment items to separate subsection. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>