Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
grantbuster authored Nov 3, 2023
1 parent f6d73fd commit 744928b
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 [email protected]: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)

Expand Down

0 comments on commit 744928b

Please sign in to comment.