Skip to content

Commit

Permalink
typos and outdated docs
Browse files Browse the repository at this point in the history
Co-authored-by: Agriya Khetarpal <[email protected]>
  • Loading branch information
Saransh-cpp and agriyakhetarpal authored Dec 12, 2024
1 parent 6f4ea8e commit cf27994
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 6 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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))

Expand Down
5 changes: 2 additions & 3 deletions docs/source/user_guide/installation/gnu-linux-mac.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 <https://computing.llnl.gov/projects/sundials/>`__
PyBaMM can be installed via ``pip`` or ``conda``.
library beforehand.

.. tab:: pip
Expand Down
2 changes: 1 addition & 1 deletion docs/source/user_guide/installation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ It can be installed using ``pip`` or ``conda``, or from source.
.. tab:: conda

PyBaMM is part of the `Anaconda <https://docs.continuum.io/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 <index.html#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>`_.
Expand Down

0 comments on commit cf27994

Please sign in to comment.