ORNL / ORNL/GridKit

JSON Schema for Model Spec & Case Formats

Open
#482 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
C++
Stars
27
Forks
11
Avg merge
3d 8h
Merged PRs (30d)
23

Description

Summary

A build manifest or possibly an API to query available models and their meta data (name, parameters, variable names, descriptions, etc)

Rationale

Invaluable for external validation, presenting simulation results, and translation of cases

Description

Essentially an API for our tables in the documetnation, or an equivilent manifest. I am not sure what the idiomatic way to to this is in modern software, or if this is something innate that I am just not aware of.

The closest thing I have to compare my request to is a MANIFEST.MF in Java

Additional information

None

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.

Research direction

Start by reviewing the documentation tables and the model and case definitions they describe; the issue names no source files or tests. Clarify whether the deliverable is a build manifest, a query API, or both, then define the metadata schema and validation criteria before implementation.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, json
Domain
backend-api-design, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.