Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#3883 updates to install from source #3884

Merged
merged 1 commit into from
Mar 11, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/source/user_guide/installation/install-from-source.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,14 @@ You can install the above with
brew install python openblas gcc gfortran graphviz libomp

Finally, we recommend using `Nox <https://nox.thea.codes/en/stable/>`_.
You can install it with
You can install it to your local user account (make sure you are not within a virtual environment) with

.. code:: bash

python3.X -m pip install --user nox

Note that running ``nox`` will create new virtual environments for you to use, so you do not need to create one yourself.

Depending on your operating system, you may or may not have ``pip`` installed along Python.
If ``pip`` is not found, you probably want to install the ``python3-pip`` package.

Expand Down Expand Up @@ -158,7 +160,7 @@ It comes ready with PyBaMM and some useful development tools like `pre-commit <h

You can now activate the environment with

.. tab:: GNU/Linux and MacOS
.. tab:: GNU/Linux and MacOS (bash)

.. code:: bash

Expand Down Expand Up @@ -189,7 +191,7 @@ tools for development and documentation:

pip install -e .[all,dev,docs]

If you are using ``zsh``, you would need to use different pattern matching:
If you are using ``zsh`` or ``tcsh``, you would need to use different pattern matching:

.. code:: bash

Expand Down
Loading