Skip to content

Simplify the structure of optical data sets#354

Merged
christoph-maurer merged 5 commits into
developfrom
simplify-optical-data
May 21, 2025
Merged

Simplify the structure of optical data sets#354
christoph-maurer merged 5 commits into
developfrom
simplify-optical-data

Conversation

@christoph-maurer
Copy link
Copy Markdown
Member

opticalData.json has been using a tree structure to allow complex optical data which may share one or more componentCharacteristics. For software developers, this tree is more complicated to implement than a simple array. We therefore exchange the tree structure by a simple array.

@christoph-maurer christoph-maurer added the ISE Fraunhofer Institute for Solar Energy Systems ISE label Mar 27, 2025
@christoph-maurer christoph-maurer self-assigned this Mar 27, 2025
@github-project-automation github-project-automation Bot moved this to 🆕 New in EQWIN-P Mar 27, 2025
@christoph-maurer
Copy link
Copy Markdown
Member Author

@simon-wacker I don't like the structure

"optical": [
  {
    "data": [
      {
        "data": [
          {
            "dataPoints": [

in the examples. But I don't see a better solution especially when the property serverSpecific is added.

"optical": [
  {
    "data": [
      {
        "data": [
          {
            "dataPoints": [...]
          }
        "serverSpecific":[...]

We could rename "optical:[{"data": to "optical:[{"opticalData":, but that doesn't solve it.

You can make changes and merge this pull request when you think that it is ok.

@simonwacker
Copy link
Copy Markdown
Contributor

I don't like the structure

I'd leave it like that for now. In practice there is a GraphQL response conforming essentially to optical.json and a GET HTTPS resource conforming to opticalData.json. The latter is not inlined with the former, unless someone does it manually. So the case data { data { ... does not really occur in practice. We could name the data in opticalData.json something like node or group or section or ... but I wouldn't do so now as that would invalidate all existing data that conforms to the current schema.

Copy link
Copy Markdown
Contributor

@simonwacker simonwacker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Superficial comments (integrate or leave as is and then just merge). The changes are solid 🥇

Comment thread schemas/opticalData.json Outdated
Comment thread schemas/opticalData.json Outdated
Comment thread schemas/opticalData.json Outdated
@christoph-maurer christoph-maurer dismissed simonwacker’s stale review May 21, 2025 14:07

Thanks for the comments! I resolved them.

@christoph-maurer christoph-maurer merged commit dacc9a9 into develop May 21, 2025
@christoph-maurer christoph-maurer deleted the simplify-optical-data branch May 21, 2025 14:08
@github-project-automation github-project-automation Bot moved this from 🆕 New to ✅ Done in EQWIN-P May 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ISE Fraunhofer Institute for Solar Energy Systems ISE

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

2 participants