Skip to content

Commit

Permalink
update install package name
Browse files Browse the repository at this point in the history
  • Loading branch information
crvernon committed Jul 8, 2024
1 parent 4a2d366 commit 3f89a18
Showing 1 changed file with 2 additions and 16 deletions.
18 changes: 2 additions & 16 deletions docs/source/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,32 +38,18 @@ Install ``GLORY`` from a command prompt or terminal:

.. code-block:: bash
pip install glory
pip install glory-reservoir
**Option 2:**

You can install the development version of ``GLORY`` from GitHub using ``pip`` in a command prompt or terminal:

.. code-block:: bash
pip install git+https://github.com/JGCRI/glory
pip install git+https://github.com/JGCRI/glory@dev
This command will automatically install the dependencies. To avoid package version conflicts, consider using a virtual environment.

**Option 3:**

Alternatively, users can clone the ``GLORY`` package from GitHub. Navigate to the desired directory:

.. code-block:: bash
git clone https://github.com/JGCRI/glory
Then, navigate into the cloned `glory` folder and install ``GLORY`` from a command prompt or terminal :

.. code-block:: bash
pip install .
Try importing ``GLORY`` to confirm that installation was successful:

.. code-block:: python
Expand Down

0 comments on commit 3f89a18

Please sign in to comment.