@@ -5,8 +5,9 @@ Downloading and Installation
5
5
.. _lmfit github repository : https://github.com/lmfit/lmfit-py
6
6
.. _python : https://python.org
7
7
.. _scipy : https://scipy.org/scipylib/index.html
8
- .. _numpy : http ://numpy.org/
8
+ .. _numpy : https ://numpy.org/
9
9
.. _pytest : https://pytest.org/
10
+ .. _pytest-cov : https://github.com/pytest-dev/pytest-cov
10
11
.. _emcee : https://emcee.readthedocs.io/
11
12
.. _pandas : https://pandas.pydata.org/
12
13
.. _jupyter : https://jupyter.org/
@@ -24,7 +25,8 @@ Downloading and Installation
24
25
.. _Pillow : https://python-pillow.org/
25
26
.. _sphinx-gallery : https://sphinx-gallery.github.io/stable/index.html
26
27
.. _flaky : https://github.com/box/flaky
27
-
28
+ .. _SymPy : https://www.sympy.org/
29
+ .. _Latexmk : https://ctan.org/pkg/latexmk/
28
30
29
31
Prerequisites
30
32
~~~~~~~~~~~~~
@@ -41,15 +43,18 @@ Lmfit requires the following Python packages, with versions given:
41
43
All of these are readily available on PyPI, and should be installed
42
44
automatically if installing with ``pip install lmfit ``.
43
45
44
- In order to run the test suite, the `pytest `_ and `flaky `_ packages are required. Some
45
- functionality requires the `emcee `_ (version 3+), `corner `_, `pandas `_, `Jupyter `_,
46
- `matplotlib `_, `dill `_, or `numdifftools `_ packages. These are not installed
47
- automatically, but we highly recommend each of these packages.
48
-
49
- For building the documentation and generating the examples gallery,
50
- `matplotlib `_, `emcee `_ (version 3+), `corner `_, `Sphinx `_, `sphinx-gallery `_,
51
- `jupyter_sphinx `_, `Pillow `_, `sphinxcontrib-svg2pdfconverter `_, and `cairosvg `_
52
- are required (the latter two only when generating the PDF document).
46
+ In order to run the test suite, the `pytest `_, `pytest-cov `_, and `flaky `_
47
+ packages are required. Some functionality requires the `emcee `_ (version 3+),
48
+ `corner `_, `pandas `_, `Jupyter `_, `matplotlib `_, `dill `_, or `numdifftools `_
49
+ packages. These are not installed automatically, but we highly recommend each
50
+ of them.
51
+
52
+ For building the documentation and generating the examples gallery, `matplotlib `_,
53
+ `emcee `_ (version 3+), `corner `_, `Sphinx `_, `sphinx-gallery `_, `jupyter_sphinx `_,
54
+ `Pillow `_, and `SymPy `_ are required. For generating the PDF documentation, the Python
55
+ packages `sphinxcontrib-svg2pdfconverter `_ and `cairosvg `_ are also required,
56
+ as well as the LaTex package `Latexmk `_ (which is included by default in some
57
+ LaTex distributions).
53
58
54
59
Please refer to ``requirements-dev.txt `` for a list of all dependencies that
55
60
are needed if you want to participate in the development of lmfit.
0 commit comments