Skip to content

Latest commit

 

History

History
21 lines (13 loc) · 1.34 KB

README.rst

File metadata and controls

21 lines (13 loc) · 1.34 KB
Raw

This repository contains YAML files describing computational models that can be used in yggdrasil integration. Models can be submitted via pull request or via this form (source code) which will validate entries, format entries as a YAML file, and open a pull request to add it.

Requirements

To be merged, a model YAML must meet the following requirements:

  1. Is a valid YAML file with valid syntax
  2. Obeys the model_form.json schema that can be downloaded from here
  3. Points to a valid commit in a Git repository that
    1. Contains a LICENSE file
    2. Passes a general review to ensure that it does not contain any nefarious code that could pose a security risk
  4. Can be run in isolation as a one-model integration

Validation Tools

YAML files can be validated locally using the yggvalidate --model-submission [YAMLFILE] command line interface provided by the yggdrasil package. yggdrasil can be installed locally or one of the yggdrasil Docker containers can be used.