Skip to content

Commit

Permalink
Updating Install Guides with min PIP version (#1664)
Browse files Browse the repository at this point in the history
ARMI depends on the pyproject.toml feature set, which is not fully supported until pip>=22.1 (which was released in May 2022). So, this version limit is mandatory.
  • Loading branch information
john-science committed Mar 12, 2024
1 parent 5fea691 commit b9f1f13
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 5 deletions.
12 changes: 8 additions & 4 deletions README.rst
Expand Up @@ -68,25 +68,29 @@ commands. You probably want to do this in a virtual environment as described in
documentation <https://terrapower.github.io/armi/installation.html>`_. Otherwise, the
dependencies could conflict with your system dependencies.

::
First, upgrade your version of pip::

$ pip install pip>=22.1

Now clone and install ARMI::

$ git clone https://github.com/terrapower/armi
$ cd armi
$ pip install -e .
$ armi
$ armi --help

The easiest way to run the tests is to install `tox <https://tox.readthedocs.io/en/latest/>`_
and then run::

$ pip install -e .[test]
$ pip install -e ".[test]"
$ tox -- -n 6

This runs the unit tests in parallel on 6 processes. Omit the ``-n 6`` argument
to run on a single process.

The tests can also be run directly, using ``pytest``::

$ pip install -e .[test]
$ pip install -e ".[test]"
$ pytest -n 4 armi

From here, we recommend going through a few of our `gallery examples
Expand Down
15 changes: 14 additions & 1 deletion doc/user/user_install.rst
Expand Up @@ -63,6 +63,18 @@ Getting the code
================
Choose one of the following two installation methods depending on your needs.

Step 0: Update PIP
------------------
In order to use the commands below, you're going to want to use a version of ``pip>=22.1``.
Two common ways of solving that are::

(armi-venv) $ pip install pip>=22.1

or, in most cases::

(armi-venv) $ pip install -U pip


Option 1: Install as a library
------------------------------
If you plan on running ARMI without viewing or modifying source code, you may
Expand All @@ -72,6 +84,7 @@ in another project::

(armi-venv) $ pip install https://github.com/terrapower/armi/archive/main.zip


Option 2: Install as a repository (for developers)
--------------------------------------------------
If you'd like to view or change the ARMI source code (common!), you need to
Expand All @@ -86,7 +99,7 @@ the git repository with::
Now install ARMI with all its dependencies::

(armi-venv) $ cd armi
(armi-venv) $ pip install -e .[test]
(armi-venv) $ pip install -e ".[test]"

.. tip:: If you don't want to install ARMI into your venv, you will need to add the ARMI source
location to your system's ``PYTHONPATH`` environment variable so that
Expand Down

0 comments on commit b9f1f13

Please sign in to comment.