From cf279949cfddb46a9747c5e7da9a389ff6ae0227 Mon Sep 17 00:00:00 2001 From: Saransh Chopra Date: Thu, 12 Dec 2024 13:49:51 +0000 Subject: [PATCH] typos and outdated docs Co-authored-by: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com> --- CHANGELOG.md | 4 ++-- docs/source/user_guide/installation/gnu-linux-mac.rst | 5 ++--- docs/source/user_guide/installation/index.rst | 2 +- 3 files changed, 5 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 06cbca77cf..920a292683 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,8 +5,8 @@ ## Breaking changes -- The conda distribution (`pybamm`) now install 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)) +- 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 855b29f584..92e1b921c3 100644 --- a/docs/source/user_guide/installation/gnu-linux-mac.rst +++ b/docs/source/user_guide/installation/gnu-linux-mac.rst @@ -50,7 +50,7 @@ To create a virtual environment ``env`` within your current directory type: virtualenv env -or use any of your preferred environment management tool. You can then “activate” +or use any of your preferred environment management tools. You can then “activate” the environment using: .. code:: bash @@ -65,8 +65,7 @@ the environment and go back to your original system, just type: deactivate -PyBaMM can be installed via ``pip`` or ``conda``. On macOS, it is necessary -to install the `SUNDIALS `__ +PyBaMM can be installed via ``pip`` or ``conda``. library beforehand. .. tab:: pip diff --git a/docs/source/user_guide/installation/index.rst b/docs/source/user_guide/installation/index.rst index c4ff08b553..bdccb972c7 100644 --- a/docs/source/user_guide/installation/index.rst +++ b/docs/source/user_guide/installation/index.rst @@ -14,7 +14,7 @@ It can be installed using ``pip`` or ``conda``, or from source. .. tab:: conda - PyBaMM is part of the `Anaconda `_ distribution and is available as a conda package through the conda-forge channel. + PyBaMM 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. At the moment, PyBaMM's conda-forge distribution does not include the `IDAKLUSolver <../../api/solvers/idaklu_solver.html#idaklu-solver>`_.