DARPA-ASKEM / Model-Representations

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

Model Inventory utility #75

Closed JosephCottam closed 7 months ago

JosephCottam commented 7 months ago

Check what information an AMR contains, produce a report.

Models kept in various repositories contain different information. The utility included loads an AMR json description, parses its content and checks for key components (rate laws, initial values, etc.) that are required for down-stream use. The utility can be pip-installed from github and be imported as a module in other projects ("from askem_model_representations import model_inventory").

The utility can be run from the command line to check multiple files. Results are output as HTML or markdown table summaries, json summary or a detailed json report.

The ciemss team wants to use this in our own testing, but thought the utility itself may be of more service in this repo.

Summary of PR contents: