hps-align

Tools needed to run HPS alignment workflow

This is a pip-installable python package; however, it will never be published to PyPI because all of its users are expected to be its developers as well.

Dependencies

Using pip to install this package whereever you wish will handle the python packages; however, we also require to have an installation of ROOT with the PyROOT bindings. You can check if this requirement is satisified in your environment by trying to import ROOT in your python terminal.

Install

Install an "editable" version of this package so it is both (a) accessible by Python form wherever and (b) will refer back to your source code so you can make changes without having to re-install.

python3 -m pip install -e .

On SDF, there isn't a good "local install" location, and the old-age of the Python (v3.6.8) and system install of setuptools (v39.2.0) prevents this editable install method from operating correctly. We get around this by manually symlinking the package rather than having pip setup a python-internal symlink. It is slow since it relies more on the filesystem, but it is operational.

# install dependencies
python3 -m pip install --user typer[all] matplotlib pandas
# "install" this package "manually"
ln -s $(realpath src/hps_align) ~/.local/lib/python3.6/site-packages/

Usage

Now that this package is "installed", you can run it from anywhere! Run the module to see an up-to-date help printout.

python3 -m hps_align --help

Generating survey constants

Here is an example of how to run the program to get the 2019 survey constants from the measurement data. Run this from the top level of hps-align.

python -m hps_align survey data 2019 survey_data/2019_file_list.json

For more information, run

python -m hps_align survey data --help