Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
50 changes: 50 additions & 0 deletions documentation/about.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,53 @@ simulation.
.. image:: gfx/amici_workflow.png
:alt: AMICI workflow

The functionality of the Python, Matlab and C++ interfaces slightly differ, as shown in the following table:

.. list-table::
:header-rows: 1
:stub-columns: 1

* - Feature \\ Interface
- Python
- C++
- Matlab
* - :term:`SBML` import
- yes (:ref:`details <amici_python_sbml_support>`)
- no
- yes (<=R2017b)
* - :term:`PySB` import
- yes
- no
- no
* - :term:`DAE` import
- no
- no
- yes
* - Forward sensitivities
- yes
- yes
- yes
* - Adjoint sensitivities
- yes
- yes
- yes
* - Steadystate sensitivities
- yes
- yes
- yes
* - Second-order sensitivities
- no
- no
- yes
* - Events
- no
- no
- yes
* - :term:`preequilibration`
- yes
- yes
- yes
* - :term:`presimulation`
- yes
- yes
- no
13 changes: 8 additions & 5 deletions documentation/python_interface.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ SBML import
AMICI can import :term:`SBML` models via the
:py:func:`amici.sbml_import.SbmlImporter` class.

.. _amici_python_sbml_support:

Status of SBML support in Python-AMICI
++++++++++++++++++++++++++++++++++++++

Expand All @@ -31,19 +33,20 @@ the semantic
(`current status <https://github.com/AMICI-dev/AMICI/actions>`_).

In addition, we currently plan to add support for the following features
(see corresponding issues for details and progress):
(see corresponding `issues <https://github.com/AMICI-dev/AMICI/milestone/14>`_
for details and progress):

- Events (currently Matlab-only)
- Algebraic rules
- Events (currently Matlab-only) (`#757 <https://github.com/AMICI-dev/AMICI/issues/757>`_)
- Algebraic rules (`#760 <https://github.com/AMICI-dev/AMICI/issues/760>`_)

contributions are welcome.

However, the following features are unlikely to be supported:

- SBML extensions
- any SBML extensions
- `factorial()`, `ceil()`, `floor()`, due to incompatibility with
symbolic sensitivity computations
- `delay()` due to missing SUNDIALS solver support
- `delay()` due to missing :term:`SUNDIALS` solver support


How to import an SBML model into AMICI
Expand Down