diff --git a/README.rst b/README.rst index d689dd0f3..b7b03454b 100644 --- a/README.rst +++ b/README.rst @@ -68,17 +68,21 @@ commands. You probably want to do this in a virtual environment as described in documentation `_. 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 `_ 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 @@ -86,7 +90,7 @@ 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 diff --git a/doc/user/user_install.rst b/doc/user/user_install.rst index 8ab44d8d4..6a454b58f 100644 --- a/doc/user/user_install.rst +++ b/doc/user/user_install.rst @@ -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 @@ -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 @@ -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