diff --git a/README.rst b/README.rst index 8be327c..eb23117 100644 --- a/README.rst +++ b/README.rst @@ -30,14 +30,20 @@ Installing ELM .. inclusion-install +Option #1 (basic usage): + +#. ``pip install NREL-elm`` + +Option #2 (developer install): + #. from home dir, ``git clone git@github.com:NREL/elm.git`` #. Create ``elm`` environment and install package - 1) Create a conda env: ``conda create -n elm`` - 2) Run the command: ``conda activate elm`` - 3) ``cd`` into the repo cloned in 1. - 4) Prior to running ``pip`` below, make sure the branch is correct (install + a) Create a conda env: ``conda create -n elm`` + b) Run the command: ``conda activate elm`` + c) ``cd`` into the repo cloned in 1. + d) Prior to running ``pip`` below, make sure the branch is correct (install from main!) - 5) Install ``elm`` and its dependencies by running: + e) Install ``elm`` and its dependencies by running: ``pip install .`` (or ``pip install -e .`` if running a dev branch or working on the source code)