README.md

Boosted HH utilities

Common code and utilities for boosted HH analyses.

• Boosted HH utilities
  • Setting up package
    • Creating a virtual environment
    • Installing package
    • Troubleshooting

Setting up package

Creating a virtual environment

First, create a virtual environment (micromamba is recommended):

# Download the micromamba setup script (change if needed for your machine https://mamba.readthedocs.io/en/latest/installation/micromamba-installation.html)
# Install: (the micromamba directory can end up taking O(1-10GB) so make sure the directory you're using allows that quota)
"${SHELL}" <(curl -L micro.mamba.pm/install.sh)
# You may need to restart your shell
micromamba env create -f environment.yaml
micromamba activate hh

Installing package

Remember to install this in your mamba environment.

# Clone the repository
git clone https://github.com/LPC-HH/boostedhh.git
cd boostedhh
# Perform an editable installation
pip install -e .
# for committing to the repository
pip install pre-commit
pre-commit install

Troubleshooting

• If your default python in your environment is not Python 3, make sure to use pip3 and python3 commands instead.

• You may also need to upgrade pip to perform the editable installation:

python3 -m pip install -e .