Installation instructions#

Clone the repository#

git clone https://github.com/NatLabRockies/herc_analysis
cd herc_analysis

Installation#

Typical installation is to install into same environment as Hercules is installed in.

UV Based Installation (Basic):#

Can use uv sync to install all dependencies and Hercules:

uv sync

or create a new environment and install:

uv venv
uv pip install -e .

UV Based Installation (Developer):#

uv sync --all-extras
uv run pre-commit install

or create a new environment and install:

uv venv
uv pip install -e .[docs,develop]

Pip Based Installation:#

pip install -e .

Pip Based Installation (Developer):#

pip install -e .[docs,develop]
pre-commit install