search

AMICI-dev / AMICI

Advanced Multilanguage Interface to CVODES and IDAS
https://amici.readthedocs.io/
Other
108 stars 30 forks source link

Doc: Fix headings in ExampleJax #2371

Closed dweindl closed 6 months ago

dweindl commented 6 months ago

To properly integrate into our sphinx docs.

Closes #2369.

:eyes: old: https://amici.readthedocs.io/en/v0.22.0/ExampleJax.html new: https://amici--2371.org.readthedocs.build/en/2371/ExampleJax.html

dweindl commented 6 months ago

Hm, there is documentation/ExampleJax.ipynb and python/examples/example_jax/ExampleJax.ipynb. The former should be a symlink to the latter, but it is not. Seems like the two have diverged. Looks like those were two independent files from the beginning (https://github.com/AMICI-dev/AMICI/pull/1996).

@FFroehlich: can you please check which one to keep?

codecov[bot] commented 6 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 77.70%. Comparing base (7a920e2) to head (1fc4f8f).

:exclamation: Current head 1fc4f8f differs from pull request most recent head 42e8f5b. Consider uploading reports for the commit 42e8f5b to get more accurate results

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/AMICI-dev/AMICI/pull/2371/graphs/tree.svg?width=650&height=150&src=pr&token=1bt9lbspzk&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AMICI-dev)](https://app.codecov.io/gh/AMICI-dev/AMICI/pull/2371?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AMICI-dev) ```diff @@ Coverage Diff @@ ## develop #2371 +/- ## ======================================== Coverage 77.70% 77.70% ======================================== Files 324 324 Lines 20864 20864 Branches 1458 1458 ======================================== Hits 16213 16213 Misses 4648 4648 Partials 3 3 ``` | [Flag](https://app.codecov.io/gh/AMICI-dev/AMICI/pull/2371/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AMICI-dev) | Coverage Δ | | |---|---|---| | [cpp](https://app.codecov.io/gh/AMICI-dev/AMICI/pull/2371/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AMICI-dev) | `73.48% <ø> (ø)` | | | [cpp_python](https://app.codecov.io/gh/AMICI-dev/AMICI/pull/2371/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AMICI-dev) | `34.23% <ø> (ø)` | | | [petab](https://app.codecov.io/gh/AMICI-dev/AMICI/pull/2371/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AMICI-dev) | `36.82% <ø> (ø)` | | | [python](https://app.codecov.io/gh/AMICI-dev/AMICI/pull/2371/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AMICI-dev) | `72.25% <ø> (ø)` | | | [sbmlsuite](https://app.codecov.io/gh/AMICI-dev/AMICI/pull/2371/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AMICI-dev) | `?` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AMICI-dev#carryforward-flags-in-the-pull-request-comment) to find out more.
FFroehlich commented 6 months ago

Hm, there is documentation/ExampleJax.ipynb and python/examples/example_jax/ExampleJax.ipynb. The former should be a symlink to the latter, but it is not. Seems like the two have diverged. Looks like those were two independent files from the beginning (#1996).

@FFroehlich: can you please check which one to keep?

You picked the right one, let’s go with python/examples/example_jax/ExampleJax.ipynb