Skip to content

Commit 9837ff4

Browse files
authored
Merge branch 'develop' into develop
2 parents 9c51f9a + 12432a8 commit 9837ff4

File tree

4 files changed

+484
-650
lines changed

4 files changed

+484
-650
lines changed

docs/source/user_guide/installation/gnu-linux-mac.rst

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -103,19 +103,6 @@ The ``pip install "pybamm[jax]"`` command automatically downloads and installs `
103103

104104
PyBaMM's full `conda-forge distribution <index.rst#installation>`_ (``pybamm``) includes ``jax`` and ``jaxlib`` by default.
105105

106-
.. _optional-iree-mlir-support:
107-
108-
Optional - IREE / MLIR support
109-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
110-
111-
Users can install ``iree`` (for MLIR just-in-time compilation) to use for main expression evaluation in the IDAKLU solver. Requires ``jax``.
112-
113-
.. code:: bash
114-
115-
pip install "pybamm[iree,jax]"
116-
117-
The ``pip install "pybamm[iree,jax]"`` command automatically downloads and installs ``pybamm`` and the compatible versions of ``jax`` and ``iree`` onto your system.
118-
119106
Uninstall PyBaMM
120107
----------------
121108

docs/source/user_guide/installation/index.rst

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,9 @@ It can be installed using ``pip`` or ``conda``, or from source.
3333
Optional solvers
3434
----------------
3535

36-
The following solvers are optionally available:
36+
The following solver is optionally available:
3737

3838
* `jax <https://jax.readthedocs.io/en/latest/notebooks/quickstart.html>`_ -based solver, see :ref:`optional-jaxsolver` .
39-
* `IREE <https://iree.dev/>`_ (`MLIR <https://mlir.llvm.org/>`_) support, see :ref:`optional-iree-mlir-support`.
4039

4140
Dependencies
4241
------------
@@ -219,17 +218,6 @@ Dependency Minimu
219218
`jaxlib <https://pypi.org/project/jaxlib/>`__ 0.4.20 jax Support library for JAX
220219
========================================================================= ================== ================== =======================
221220

222-
IREE dependencies
223-
^^^^^^^^^^^^^^^^^
224-
225-
Installable with ``pip install "pybamm[iree]"`` (requires ``jax`` dependencies to be installed).
226-
227-
========================================================================= ================== ================== =======================
228-
Dependency Minimum Version pip extra Notes
229-
========================================================================= ================== ================== =======================
230-
`iree-compiler <https://iree.dev/>`__ 20240507.886 iree IREE compiler
231-
========================================================================= ================== ================== =======================
232-
233221
Full installation guide
234222
-----------------------
235223

pyproject.toml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,13 +115,12 @@ dev = [
115115

116116
]
117117
# For the Jax solver.
118-
# Note: These must be kept in sync with the versions defined in pybamm/util.py, and
119-
# must remain compatible with IREE (see noxfile.py for IREE compatibility).
118+
# Note: These must be kept in sync with the versions defined in pybamm/util.py
120119
jax = [
121120
"jax==0.4.27",
122121
"jaxlib==0.4.27",
123122
]
124-
# Contains all optional dependencies, except for jax, iree, and dev dependencies
123+
# Contains all optional dependencies, except for jax, and dev dependencies
125124
all = [
126125
"scikit-fem>=8.1.0",
127126
"pybamm[examples,plot,cite,bpx,tqdm]",

0 commit comments

Comments
 (0)