Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add instructions for pip installation to the docs #690

Merged
merged 6 commits into from
Jan 28, 2025
Merged
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions docs/sections/user_guide/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,34 @@ Build the ``uwtools`` Package Locally
.. code-block:: text

conda create -y -n uwtools -c $CONDA_PREFIX/conda-bld -c conda-forge --override-channels uwtools[=<version>]


Install ``uwtools`` into a non-conda environment
------------------------------------------------

If you are using an app that has its own environment requirements that do not work well with conda, you may need to use pip instead.
WeirAE marked this conversation as resolved.
Show resolved Hide resolved

#. First, you will need to clone the git repo and check out the current release version. If you are using a tier 1 machine with a central installation, it is recommended to use that location.
WeirAE marked this conversation as resolved.
Show resolved Hide resolved

.. code-block:: text

git checkout <version>
WeirAE marked this conversation as resolved.
Show resolved Hide resolved

#. To not pollute your base Python environment, it is recommended to create and activate your own environment. If you are installing into an existing spack or cmake build, skip to the last step.
WeirAE marked this conversation as resolved.
Show resolved Hide resolved

.. code-block:: text

python -m venv uwtools

#. In the :uwtools:`uwtools repository<>`, activate your environment:

.. code-block:: text

. uwtools/bin/activate
WeirAE marked this conversation as resolved.
Show resolved Hide resolved

#. Then navigate to the ``src`` directory and install to the active environment using ``pip``. This will also install all dependencies.:

.. code-block:: text

cd ~/git/uwtools/src
pip install .
WeirAE marked this conversation as resolved.
Show resolved Hide resolved
Loading