Skip to content

Commit

Permalink
Move pip package installation instruction above editable installation…
Browse files Browse the repository at this point in the history
… to keep it from getting lost in the editable instructions
  • Loading branch information
softwareengineerprogrammer committed Jul 8, 2024
1 parent 3f2adb4 commit 0de2cd9
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,17 @@ The short URL `bit.ly/GEOPHIRES <https://bit.ly/GEOPHIRES>`__ redirects to the s
Installation
------------

Pip Package
^^^^^^^^^^^

If you do not need to view or edit GEOPHIRES-X source code, you can consume GEOPHIRES-X as a regular, non-editable python package::

pip3 install https://github.com/NREL/GEOPHIRES-X/archive/main.zip


.. (Eventually package will be published to PyPi, enabling ``pip install geophires-x``)
Editable Installation (Recommended)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down Expand Up @@ -142,15 +153,6 @@ To update the editable installation with the latest GEOPHIRES version::
# resolve merge conflicts, if any
pip install -e .

Pip Package
^^^^^^^^^^^

If you do not need to view or edit GEOPHIRES-X source code, you can consume GEOPHIRES-X as a regular, non-editable python package::

pip3 install https://github.com/NREL/GEOPHIRES-X/archive/main.zip


.. (Eventually package will be published to PyPi, enabling ``pip install geophires-x``)


Usage
Expand Down

0 comments on commit 0de2cd9

Please sign in to comment.