updated warning message about outdated list of dependencies (#4719)

* updated warning message * Message updated * Modified dependecies section for better understanding * Update docs/source/user_guide/installation/index.rst Co-authored-by: Agriya Khetarpal <[email protected]> * Update docs/source/user_guide/installation/index.rst Co-authored-by: Agriya Khetarpal <[email protected]> * Update docs/source/user_guide/installation/index.rst Co-authored-by: Saransh Chopra <[email protected]> * Link added to pyproject.toml * use main --------- Co-authored-by: Agriya Khetarpal <[email protected]> Co-authored-by: Eric G. Kratz <[email protected]> Co-authored-by: Saransh Chopra <[email protected]>
pybamm-team · Jan 3, 2025 · f79cd26 · f79cd26
1 parent bb28150
commit f79cd26
Showing 1 changed file with 14 additions and 12 deletions.
diff --git a/docs/source/user_guide/installation/index.rst b/docs/source/user_guide/installation/index.rst
@@ -49,7 +49,9 @@ PyBaMM requires the following dependencies:
 
 .. warning::
 
-    The list of dependencies below might be outdated. Please refer to the ``pyproject.toml`` file to find all dependencies.
+    The list of dependencies below might be outdated. Users are advised to manually check the `pyproject.toml`_ file to find out supported versions.
+
+.. _pyproject.toml: https://github.com/pybamm-team/PyBaMM/blob/main/pyproject.toml
 
 .. _install-required-dependencies:
 
@@ -61,18 +63,18 @@ Required dependencies
 PyBaMM requires the following dependencies.
 
 =================================================================== ==========================
-Package                                                             Minimum supported version
+Package                                                             Supported version(s)
 =================================================================== ==========================
-`NumPy <https://numpy.org>`__                                         1.23.5
-`SciPy <https://docs.scipy.org/doc/scipy/>`__                         1.9.3
-`CasADi <https://web.casadi.org/docs/>`__                             3.6.3
-`Xarray <https://docs.xarray.dev/en/stable/>`__                       2022.6.0
-`Anytree <https://anytree.readthedocs.io/en/stable/>`__               2.8.0
-`SymPy <https://docs.sympy.org/latest/index.html>`__                  1.9.3
-`typing-extensions <https://pypi.org/project/typing-extensions/>`__  4.10.0
-`pandas <https://pypi.org/project/pandas/>`__                         1.5.0
-`pooch <https://www.fatiando.org/pooch/>`__                           1.8.1
-`posthog <https://posthog.com/>`__                                    3.6.5
+`NumPy <https://numpy.org>`__                                         >= 1.23.5, <2
+`SciPy <https://docs.scipy.org/doc/scipy/>`__                         Whatever recent versions work. >= 1.9.3
+`CasADi <https://web.casadi.org/docs/>`__                             Whatever recent versions work. >= 3.6.7
+`Xarray <https://docs.xarray.dev/en/stable/>`__                       Whatever recent versions work. >= 2022.6.0
+`Anytree <https://anytree.readthedocs.io/en/stable/>`__               Whatever recent versions work. >= 2.8.0
+`SymPy <https://docs.sympy.org/latest/index.html>`__                  Whatever recent versions work. >= 1.9.3
+`typing-extensions <https://pypi.org/project/typing-extensions/>`__   Whatever recent versions work. >= 4.10.0
+`pandas <https://pypi.org/project/pandas/>`__                         Whatever recent versions work. >= 1.5.0
+`pooch <https://www.fatiando.org/pooch/>`__                           Whatever recent versions work. >= 1.8.1
+`posthog <https://posthog.com/>`__                                    Whatever recent versions work. >= 3.6.5
 `pyyaml <https://pyyaml.org/>`__
 `platformdirs <https://platformdirs.readthedocs.io/en/latest/>`__
 =================================================================== ==========================