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 all 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
28 changes: 28 additions & 0 deletions docs/sections/user_guide/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,31 @@ 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 install with ``pip`` instead.

#. Clone the ``uwtools`` repo and check out the desired release tag.

.. code-block:: text

git clone https://github.com/ufs-community/uwtools.git
cd uwtools
git checkout <tag>

#. Optional but recommended: Create and activate a Python virtual environment, to avoid installing into the base Python installation.

.. code-block:: text

python -m venv uwtools-venv
. uwtools-venv/bin/activate

#. Install ``uwtools`` and its required dependencies from the ``src/`` directory:

.. code-block:: text

cd src/
pip install .
Loading