Skip to content

Commit

Permalink
Add required attribute to extensions in yaml file (#545)
Browse files Browse the repository at this point in the history
PEtab extensions were introduced in #537. We should be able to distinguish there between optional extensions and required extensions, i.e. those that modify the parameter estimation problem as such, and those that just add additional/optional information (e.g. annotations, info for visualization, ...). If some tool does not know about a certain optional extension, it can safely be ignored during import, if it does not know about a required extension, it should fail.

This PR adds a `required` attribute to extensions in the yaml file to indicate whether they are required for the mathematical interpretation of the PEtab problem.

Resolves #544
  • Loading branch information
dweindl committed Jul 20, 2022
1 parent dd6a470 commit 7b76617
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions doc/_static/petab_schema.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -98,14 +98,19 @@ properties:
version:
type: string
pattern: ^([1-9][0-9]*!)?(0|[1-9][0-9]*)(\.(0|[1-9][0-9]*))*((a|b|rc)(0|[1-9][0-9]*))?(\.post(0|[1-9][0-9]*))?(\.dev(0|[1-9][0-9]*))?$

required:
type: bool
description: |
Indicates whether the extension is required for the
mathematical interpretation of problem.
required:
- version
- required
additionalProperties: true

additionalProperties: false

required:
- format_version
- parameter_file
- problems
- problems

0 comments on commit 7b76617

Please sign in to comment.