DARPA-ASKEM / Model-Representations

Modeling framework representations for ASKEM
https://darpa-askem.github.io/Model-Representations/
8 stars 2 forks source link

Inconsistency in properties within the schemas #18

Closed liunelson closed 1 year ago

liunelson commented 1 year ago

We had a discussion on what should shown in the model page of Terarium. Can we make sure that all the properties^ of "model" have at least:

  1. an unique string that works a short name for this property (expressions would use this)
  2. an arbitrarily long string that describes what this property is

^ ("vertices", "edges", "parameters") in RegNets and ("states", "transitions", "parameters") in PetriNets

Currently, (1) is provided inconsistently by "id" and "name while (2) is provided by a "description" that is not always present.

Example:

  1. lotka_volterra.json:

    "model": {"vertices": [{"id": "R", description": "Population of rabbits", ...}

  2. sir.json:

    "model": {"states": [{"id": "S", "description": "Population of susceptible humans", ...}

jpfairbanks commented 1 year ago

We probably want all three levels of length? Like R, Rabbits, The population of rabbits