Skip to content

Commit ec55af6

Browse files
authored
doc: fix paths, formatting, typos (#2674)
1 parent 0e4ea68 commit ec55af6

File tree

3 files changed

+23
-21
lines changed

3 files changed

+23
-21
lines changed

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -128,23 +128,25 @@ There is a list of [publications using AMICI](https://amici.readthedocs.io/en/la
128128
If you used AMICI in your work, we are happy to include
129129
your project, please let us know via a GitHub issue.
130130

131-
When using AMICI in your project, please cite
131+
When using AMICI in your project, please cite:
132+
132133
* Fröhlich, F., Weindl, D., Schälte, Y., Pathirana, D., Paszkowski, Ł., Lines, G.T., Stapor, P. and Hasenauer, J., 2021.
133134
AMICI: High-Performance Sensitivity Analysis for Large Ordinary Differential Equation Models. Bioinformatics, btab227,
134135
[DOI:10.1093/bioinformatics/btab227](https://doi.org/10.1093/bioinformatics/btab227).
135-
```
136-
@article{frohlich2020amici,
137-
title={AMICI: High-Performance Sensitivity Analysis for Large Ordinary Differential Equation Models},
138-
author={Fr{\"o}hlich, Fabian and Weindl, Daniel and Sch{\"a}lte, Yannik and Pathirana, Dilan and Paszkowski, {\L}ukasz and Lines, Glenn Terje and Stapor, Paul and Hasenauer, Jan},
139-
journal = {Bioinformatics},
140-
year = {2021},
141-
month = {04},
142-
issn = {1367-4803},
143-
doi = {10.1093/bioinformatics/btab227},
144-
note = {btab227},
145-
eprint = {https://academic.oup.com/bioinformatics/advance-article-pdf/doi/10.1093/bioinformatics/btab227/36866220/btab227.pdf},
146-
}
147-
```
136+
137+
```bibtex
138+
@article{frohlich2020amici,
139+
title={AMICI: High-Performance Sensitivity Analysis for Large Ordinary Differential Equation Models},
140+
author={Fr{\"o}hlich, Fabian and Weindl, Daniel and Sch{\"a}lte, Yannik and Pathirana, Dilan and Paszkowski, {\L}ukasz and Lines, Glenn Terje and Stapor, Paul and Hasenauer, Jan},
141+
journal = {Bioinformatics},
142+
year = {2021},
143+
month = {04},
144+
issn = {1367-4803},
145+
doi = {10.1093/bioinformatics/btab227},
146+
note = {btab227},
147+
eprint = {https://academic.oup.com/bioinformatics/advance-article-pdf/doi/10.1093/bioinformatics/btab227/36866220/btab227.pdf},
148+
}
149+
```
148150

149151
When presenting work that employs AMICI, feel free to use one of the icons in
150152
[doc/gfx/](https://github.com/AMICI-dev/AMICI/tree/master/doc/gfx),

doc/background.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,13 +52,13 @@ publications:
5252
.. note::
5353

5454
Implementation details of the latest AMICI versions may differ from the ones
55-
given in the references manuscripts.
55+
given in the referenced manuscripts.
5656

5757

5858
Third-Party numerical algorithms used by AMICI
5959
----------------------------------------------
6060

61-
AMICI uses the following packages from SUNDIALS:
61+
AMICI uses the following packages from `SUNDIALS <https://computing.llnl.gov/projects/sundials>`__:
6262

6363
* CVODES:
6464

@@ -70,7 +70,7 @@ AMICI uses the following packages from SUNDIALS:
7070

7171
* IDAS
7272

73-
AMICI uses the following packages from SuiteSparse:
73+
AMICI uses the following packages from `SuiteSparse <https://github.com/DrTimothyAldenDavis/SuiteSparse>`__:
7474

7575
* Algorithm 907: **KLU** A Direct Sparse Solver for Circuit Simulation
7676
Problems. Timothy A. Davis, Ekanathan Palamadai Natarajan,

doc/how_to_cite.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,12 @@ When using AMICI in your project, please cite
3232
}
3333
3434
When presenting work that employs AMICI, feel free to use one of the icons in
35-
`documentation/gfx/ <https://github.com/AMICI-dev/AMICI/tree/master/documentation/gfx>`_,
35+
`documentation/gfx/ <https://github.com/AMICI-dev/AMICI/tree/master/doc/gfx>`_,
3636
which are available under a
37-
`CC0 <https://github.com/AMICI-dev/AMICI/tree/master/documentation/gfx/LICENSE.md>`_
37+
`CC0 <https://github.com/AMICI-dev/AMICI/tree/master/doc/gfx/LICENSE.md>`_
3838
license:
3939

40-
.. image:: https://raw.githubusercontent.com/AMICI-dev/AMICI/master/documentation/gfx/logo_text.png
41-
:target: https://raw.githubusercontent.com/AMICI-dev/AMICI/master/documentation/gfx/logo_text.png
40+
.. image:: https://raw.githubusercontent.com/AMICI-dev/AMICI/master/doc/gfx/logo_text.png
41+
:target: https://raw.githubusercontent.com/AMICI-dev/AMICI/master/doc/gfx/logo_text.png
4242
:height: 75
4343
:alt: AMICI LOGO

0 commit comments

Comments
 (0)