Installing ngen cal

Installing the calibration package

The following directions assume a minimal python 3.8 version.

From Source

git clone https://github.com/NOAA-OWP/ngen-cal && cd ngen-cal

# create python virtual environment
python -m venv venv
source ./venv/bin/activate

pip install python/ngen_cal

Install From GitHub

# create python virtual environment
python -m venv venv
source ./venv/bin/activate

pip install "git+https://github.com/noaa-owp/ngen-cal@master#egg=ngen_cal&subdirectory=python/ngen_cal"

Installation Notes

Mac OSX users may encounter issues installing the tables library when installing ngen.cal. Users who encounter this issue and use homebrew should first install hdf5 (brew install hdf5), then export HDF5_DIR=$(brew --prefix hdf5), and finally re-installing ngen.cal.

As a python dependency in another project

Add the following to a requirements.txt file:

git+https://github.com/noaa-owp/ngen-cal@master#egg=ngen-config&subdirectory=python/ngen_conf
git+https://github.com/noaa-owp/ngen-cal@master#egg=ngen-cal&subdirectory=python/ngen_cal

Add the following to a setup.cfg file:

install_requires =
    ngen_cal @ git+https://github.com/noaa-owp/ngen-cal@master#egg=ngen_cal&subdirectory=python/ngen_cal