diff --git a/docs/source/user_guide/installation/GNU-linux.rst b/docs/source/user_guide/installation/GNU-linux.rst index ca95bbe1b5..cf027db587 100644 --- a/docs/source/user_guide/installation/GNU-linux.rst +++ b/docs/source/user_guide/installation/GNU-linux.rst @@ -133,7 +133,10 @@ Optional - JaxSolver ~~~~~~~~~~~~~~~~~~~~ Users can install ``jax`` and ``jaxlib`` to use the Jax solver. -Currently, only GNU/Linux and macOS are supported. + +.. note:: + + The Jax solver is not supported on Python 3.8. It is supported on Python 3.9, 3.10, and 3.11. .. code:: bash diff --git a/docs/source/user_guide/installation/index.rst b/docs/source/user_guide/installation/index.rst index 2b8b7fe304..65cbad33fb 100644 --- a/docs/source/user_guide/installation/index.rst +++ b/docs/source/user_guide/installation/index.rst @@ -217,13 +217,13 @@ Dependency Minimum Version p Jax dependencies ^^^^^^^^^^^^^^^^^ -Installable with ``pip install "pybamm[jax]"`` +Installable with ``pip install "pybamm[jax]"``, currently supported on Python 3.9-3.11. ========================================================================= ================== ================== ======================= Dependency Minimum Version pip extra Notes ========================================================================= ================== ================== ======================= -`JAX `__ 0.4.8 jax For JAX solvers -`jaxlib `__ 0.4.7 jax Support library for JAX +`JAX `__ 0.4.20 jax For the JAX solver +`jaxlib `__ 0.4.20 jax Support library for JAX ========================================================================= ================== ================== ======================= .. _install.odes_dependencies: diff --git a/docs/source/user_guide/installation/windows.rst b/docs/source/user_guide/installation/windows.rst index 5b104e91bd..5ad77b6f7f 100644 --- a/docs/source/user_guide/installation/windows.rst +++ b/docs/source/user_guide/installation/windows.rst @@ -66,6 +66,21 @@ installed automatically when you install PyBaMM using ``pip``. For an introduction to virtual environments, see (https://realpython.com/python-virtual-environments-a-primer/). +Optional - JaxSolver +~~~~~~~~~~~~~~~~~~~~ + +Users can install ``jax`` and ``jaxlib`` to use the Jax solver. + +.. note:: + + The Jax solver is not supported on Python 3.8. It is supported on Python 3.9, 3.10, and 3.11. + +.. code:: bash + + pip install "pybamm[jax]" + +The ``pip install "pybamm[jax]"`` command automatically downloads and installs ``pybamm`` and the compatible versions of ``jax`` and ``jaxlib`` on your system. (``pybamm_install_jax`` is deprecated.) + Uninstall PyBaMM ----------------