Skip to content

Commit

Permalink
Doc: Include hdf5 functions in Python API doc (#2606)
Browse files Browse the repository at this point in the history
* requires libhdf5 on RTD
* exclude developer info from API doc
* minor other doc fixes
  • Loading branch information
dweindl authored Nov 28, 2024
1 parent e77fabb commit e7d354a
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 3 deletions.
1 change: 1 addition & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ build:
os: "ubuntu-22.04"
apt_packages:
- libatlas-base-dev
- libhdf5-serial-dev
- swig
tools:
python: "3.11"
1 change: 1 addition & 0 deletions documentation/cpp_installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Prerequisites:
* a C++17 compatible compiler
* a C compiler
* Optional:

* HDF5 libraries
* boost for serialization

Expand Down
3 changes: 2 additions & 1 deletion include/amici/solver.h
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ namespace amici {
* variables and status flags) are specified as mutable and not included in
* serialization or equality checks. No solver setting parameter should be
* marked mutable.
*
*/
/*
* NOTE: Any changes in data members here must be propagated to copy ctor,
* equality operator, serialization functions in serialization.h, and
* amici::hdf5::(read/write)SolverSettings(From/To)HDF5 in hdf5.cpp.
Expand Down
4 changes: 2 additions & 2 deletions python/examples/example_steadystate/ExampleSteadystate.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"source": [
"# SBML import, observation model, sensitivity analysis, data export and visualization\n",
"\n",
"This is an example using the [model_steadystate_scaled.sbml] model to demonstrate:\n",
"This is an example using the [model_steadystate_scaled.xml] model to demonstrate:\n",
"\n",
"* SBML import\n",
"* specifying the observation model\n",
Expand Down Expand Up @@ -988,7 +988,7 @@
{
"cell_type": "markdown",
"metadata": {},
"source": "The provided measurements can be visualized together with the simulation results by passing the `Expdata` to `amici.plotting.plot_observable_trajectories`:"
"source": "The provided measurements can be visualized together with the simulation results by passing the `ExpData` to `amici.plotting.plot_observable_trajectories`:"
},
{
"cell_type": "code",
Expand Down

0 comments on commit e7d354a

Please sign in to comment.