Skip to content

Commit

Permalink
Merge pull request #3318 from kratman/docs/tutorialSuggestions
Browse files Browse the repository at this point in the history
Documentation suggestions for the installation and tutorials
  • Loading branch information
Saransh-cpp authored Sep 13, 2023
2 parents ec5383c + 5d01a4a commit 55ae576
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
14 changes: 7 additions & 7 deletions docs/source/user_guide/installation/install-from-source.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,17 +42,17 @@ You can install the above with
Where ``X`` is the version sub-number.

.. note::

On Windows, you can install ``graphviz`` using the `Chocolatey <https://chocolatey.org/>`_ package manager, or
follow the instructions on the `graphviz website <https://graphviz.org/download/>`_.

.. tab:: MacOS

.. code:: bash
brew install python openblas gcc gfortran graphviz libomp
.. note::

On Windows, you can install ``graphviz`` using the `Chocolatey <https://chocolatey.org/>`_ package manager, or
follow the instructions on the `graphviz website <https://graphviz.org/download/>`_.

Finally, we recommend using `Nox <https://nox.thea.codes/en/stable/>`_.
You can install it with

Expand Down Expand Up @@ -114,7 +114,7 @@ Using Nox (recommended)
nox -s dev
.. note::
It is recommended to use ``--verbose`` or ``-v`` to see outputs of all commands run.
It is recommended to use ``--verbose`` or ``-v`` to see outputs of all commands run.

This creates a virtual environment ``.nox/dev`` inside the ``PyBaMM/`` directory.
It comes ready with PyBaMM and some useful development tools like `pre-commit <https://pre-commit.com/>`_ and `ruff <https://beta.ruff.rs/docs/>`_.
Expand All @@ -131,7 +131,7 @@ You can now activate the environment with

.. code:: bash
.nox\dev\Scripts\activate.bat
.nox\dev\Scripts\activate.bat
and run the tests to check your installation.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/user_guide/installation/windows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,4 +82,4 @@ Installation using WSL

If you want to install the optional PyBaMM solvers, you have to use the
Windows Subsystem for Linux (WSL). You can find the installation
instructions `here <INSTALL-WINDOWS-WSL.md>`__.
instructions `here <windows-wsl.html>`__.

0 comments on commit 55ae576

Please sign in to comment.