diff --git a/CHANGELOG.md b/CHANGELOG.md
index 508c5f3058..920a292683 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -5,6 +5,8 @@
## Breaking changes
+- The conda distribution (`pybamm`) now installs all optional dependencies available on conda-forge. Use the new `pybamm-base` conda
+package to install PyBaMM with only the required dependencies. ([conda-forge/pybamm-feedstock#70](https://github.com/conda-forge/pybamm-feedstock/pull/70))
- Separated extrapolation options for `pybamm.BoundaryValue` and `pybamm.BoundaryGradient`, and updated the default to be "linear" for the value and "quadratic" for the gradient. ([#4614](https://github.com/pybamm-team/PyBaMM/pull/4614))
- Double-layer SEI models have been removed (with the corresponding parameters). All models assume now a single SEI layer. ([#4470](https://github.com/pybamm-team/PyBaMM/pull/4470))
diff --git a/docs/source/user_guide/installation/gnu-linux-mac.rst b/docs/source/user_guide/installation/gnu-linux-mac.rst
index 97171b53b7..877462b5ac 100644
--- a/docs/source/user_guide/installation/gnu-linux-mac.rst
+++ b/docs/source/user_guide/installation/gnu-linux-mac.rst
@@ -50,7 +50,8 @@ To create a virtual environment ``env`` within your current directory type:
virtualenv env
-You can then “activate” the environment using:
+or use any of your preferred environment management tools. You can then “activate”
+the environment using:
.. code:: bash
@@ -64,27 +65,28 @@ the environment and go back to your original system, just type:
deactivate
-PyBaMM can be installed via pip. On macOS, it is necessary to install the `SUNDIALS `__
+PyBaMM can be installed via ``pip`` or ``conda``.
library beforehand.
-.. tab:: GNU/Linux
-
- In a terminal, run the following command:
+.. tab:: pip
.. code:: bash
pip install pybamm
-.. tab:: macOS
+.. tab:: conda
+
+ .. note::
- In a terminal, run the following command:
+ At the moment, PyBaMM's conda-forge distribution does not include ``IDAKLUSolver``.
.. code:: bash
- pip install pybamm
+ conda install -c conda-forge pybamm-base
-PyBaMM’s required dependencies (such as ``numpy``, ``casadi``, etc) will be
-installed automatically when you install PyBaMM using ``pip``.
+PyBaMM’s `required dependencies `_
+(such as ``numpy``, ``casadi``, etc) will be installed automatically when you
+install ``pybamm`` using ``pip`` or ``pybamm-base`` using ``conda``.
For an introduction to virtual environments, see
(https://realpython.com/python-virtual-environments-a-primer/).
@@ -101,6 +103,8 @@ Users can install ``jax`` and ``jaxlib`` to use the Jax solver.
The ``pip install "pybamm[jax]"`` command automatically downloads and installs ``pybamm`` and the compatible versions of ``jax`` and ``jaxlib`` on your system.
+PyBaMM's full `conda-forge distribution `_ (``pybamm``) includes ``jax`` and ``jaxlib`` by default.
+
.. _optional-iree-mlir-support:
Optional - IREE / MLIR support
diff --git a/docs/source/user_guide/installation/index.rst b/docs/source/user_guide/installation/index.rst
index 9225f1ee98..9fb81c8532 100644
--- a/docs/source/user_guide/installation/index.rst
+++ b/docs/source/user_guide/installation/index.rst
@@ -4,42 +4,33 @@ Installation
PyBaMM is available on GNU/Linux, MacOS and Windows.
It can be installed using ``pip`` or ``conda``, or from source.
-.. tab:: GNU/Linux and Windows
+.. tab:: pip
- .. tab:: pip
+ PyBaMM can be installed via pip from `PyPI `__.
- PyBaMM can be installed via pip from `PyPI `__.
+ .. code:: bash
- .. code:: bash
+ pip install pybamm
- pip install pybamm
+.. tab:: conda
- .. tab:: conda
+ PyBaMM is available as a ``conda`` package through the conda-forge channel.
- PyBaMM is part of the `Anaconda `_ distribution and is available as a conda package through the conda-forge channel.
+ The ``pybamm`` package on conda-forge installs PyBaMM with all the `required and optional dependencies `_ available on conda-forge.
- .. code:: bash
+ .. note::
- conda install -c conda-forge pybamm
+ At the moment, PyBaMM's conda-forge distribution does not include ``IDAKLUSolver``.
-.. tab:: macOS
+ .. code:: bash
- .. tab:: pip
+ conda install -c conda-forge pybamm
- PyBaMM can be installed via pip from `PyPI `__.
+ The ``pybamm-base`` package installs PyBaMM only with its `required dependencies `_.
- .. code:: bash
+ .. code:: bash
- pip install pybamm
-
-
- .. tab:: conda
-
- PyBaMM is part of the `Anaconda `_ distribution and is available as a conda package through the conda-forge channel.
-
- .. code:: bash
-
- conda install -c conda-forge pybamm
+ conda install -c conda-forge pybamm-base
Optional solvers
diff --git a/docs/source/user_guide/installation/install-from-docker.rst b/docs/source/user_guide/installation/install-from-docker.rst
index aeffdd25a1..11771765c7 100644
--- a/docs/source/user_guide/installation/install-from-docker.rst
+++ b/docs/source/user_guide/installation/install-from-docker.rst
@@ -13,7 +13,7 @@ Ensure Docker installation by running:
.. code:: bash
- docker --version
+ docker --version
Pulling the Docker image
------------------------
diff --git a/docs/source/user_guide/installation/windows.rst b/docs/source/user_guide/installation/windows.rst
index 44dc79a7d3..5e7405abb4 100644
--- a/docs/source/user_guide/installation/windows.rst
+++ b/docs/source/user_guide/installation/windows.rst
@@ -40,7 +40,8 @@ type:
python -m virtualenv env
-You can then “activate” the environment using:
+or use any of your preferred environment management tools. You can then “activate”
+the environment using:
.. code::
@@ -56,12 +57,25 @@ the environment and go back to your original system, just type:
PyBaMM can be installed via pip:
-.. code:: bash
+.. tab:: pip
+
+ .. code:: bash
+
+ pip install pybamm
+
+.. tab:: conda
- pip install pybamm
+ .. note::
-PyBaMM’s dependencies (such as ``numpy``, ``scipy``, etc) will be
-installed automatically when you install PyBaMM using ``pip``.
+ At the moment, PyBaMM's conda-forge distribution does not include ``IDAKLUSolver``.
+
+ .. code:: bash
+
+ conda install -c conda-forge pybamm-base
+
+PyBaMM’s `required dependencies `_
+(such as ``numpy``, ``casadi``, etc) will be installed automatically when you
+install ``pybamm`` using ``pip`` or ``pybamm-base`` using ``conda``.
For an introduction to virtual environments, see
(https://realpython.com/python-virtual-environments-a-primer/).
@@ -77,6 +91,8 @@ Users can install ``jax`` and ``jaxlib`` to use the Jax solver.
The ``pip install "pybamm[jax]"`` command automatically downloads and installs ``pybamm`` and the compatible versions of ``jax`` and ``jaxlib`` on your system.
+PyBaMM's full `conda-forge distribution `_ (``pybamm``) includes ``jax`` and ``jaxlib`` by default.
+
Uninstall PyBaMM
----------------