Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Doc: Add list of supported SBML test tags #1428

Merged
merged 2 commits into from
Feb 18, 2021
Merged

Doc: Add list of supported SBML test tags #1428

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e7abc95
Doc: Add list of supported SBML test tags
dweindl Feb 18, 2021
db457fb
Update documentation/python_interface.rst
dweindl Feb 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 31 additions & 3 deletions documentation/python_interface.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,34 @@ the semantic
`SBML Test Suite <https://github.com/sbmlteam/sbml-test-suite/>`_
(`current status <https://github.com/AMICI-dev/AMICI/actions>`_).

The following SBML test tags are supported
(i.e., at least one test case with the respective test passes;
`tag descriptions <https://github.com/sbmlteam/sbml-test-suite/blob/master/docs/tags-documentation/all-tags.txt>`_):

* 0D-Compartment
* Amount
* AssignedConstantStoichiometry
* AssignedVariableStoichiometry
* BoolNumericSwap
* BoundaryCondition
* Concentration
* ConstantSpecies
* ConversionFactors
* HasOnlySubstanceUnits
* InitialValueReassigned
* L3v2MathML
* LocalParameters
* MultiCompartment
* NoMathML
* NonConstantCompartment
* NonConstantParameter
* NonUnityCompartment
* NonUnityStoichiometry
* ReversibleReaction
* SpeciesReferenceInMath
* UncommonMathML
* VolumeConcentrationRates

In addition, we currently plan to add support for the following features
(see corresponding `issues <https://github.com/AMICI-dev/AMICI/milestone/14>`_
for details and progress):
Expand All @@ -50,9 +78,9 @@ However, the following features are unlikely to be supported:
Tutorials
+++++++++

A basic tutorial on how to import and simulate SBML models is available in the
`Getting Started notebook <GettingStarted.ipynb>`_, while a more detailed example
including customized import and sensitivity computation is available in the
A basic tutorial on how to import and simulate SBML models is available in the
`Getting Started notebook <GettingStarted.ipynb>`_, while a more detailed example
including customized import and sensitivity computation is available in the
`Example Steadystate notebook <ExampleSteadystate.ipynb>`_.

PySB import
Expand Down