diff --git a/docs/source/user_guide/installation/install-from-source.rst b/docs/source/user_guide/installation/install-from-source.rst index 787778fa01..ce5d7e0ca3 100644 --- a/docs/source/user_guide/installation/install-from-source.rst +++ b/docs/source/user_guide/installation/install-from-source.rst @@ -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 `_ package manager, or + follow the instructions on the `graphviz website `_. + .. tab:: MacOS .. code:: bash brew install python openblas gcc gfortran graphviz libomp -.. note:: - - On Windows, you can install ``graphviz`` using the `Chocolatey `_ package manager, or - follow the instructions on the `graphviz website `_. - Finally, we recommend using `Nox `_. You can install it with @@ -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 `_ and `ruff `_. @@ -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. diff --git a/docs/source/user_guide/installation/windows.rst b/docs/source/user_guide/installation/windows.rst index 20e4129709..6ff48293bd 100644 --- a/docs/source/user_guide/installation/windows.rst +++ b/docs/source/user_guide/installation/windows.rst @@ -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 `__. +instructions `here `__.