OpenEnergyPlatform / OpenEnergyPlatform/omi

Inconsistent omi field names compared to oemetadata spec

Open
#84 0 comments 0 reactions 1 assignee View on GitHub

@jh-RLI is already working on this.

Since Nov 30, 2022.

part: frontend :desktop_computer: priority: low :sloth: status: blocked :stop_sign: type: bug :bug:
Dominant language
Python
Stars
8
Forks
8
PR merge metrics
No merged PRs in 30d

Description

I used omi and when I output each field, the order is not the same as in the schema and there is a difference between the namings. Furthermore, there are also more fields displayed in omi than in the schema.

Here is a list of what I found:
General Keys:

  • ID = identifier
  • language = languages
  • publicationDate = publication_date
  • context
    • sourceCode = source_code
    • grantNo = grant_number
    • fundingAgency = funding_agency
      Spatial and Temporal Keys
  • referenceDate = reference_date
  • timeseries = timeseries_collection
    • start = ts_start
    • end = ts_end
    • resolution = ts_resolution
    • alignment = ts_orientation
    • aggregationType = aggregation
      Source Keys
  • sources, licenses (In omi.licenses but not in schema)
    • identifier = title
    • other_references
    • text
    • comment
      Contributor Keys
  • title = name
    Resource Keys
  • All resources are shown with all keys and values at the end which shouldn't happen

There is also a problem that omi only outputs fields with values, if values = null --> these are not shown

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.