Installation

Install with PyPI

1. Create and activate a conda environment.

conda create -n vhrharmonize -c conda-forge gdal python=3.11
conda activate vhrharmonize

1. Install the package with default dependencies.

pip install vhrharmonize[defaults]

1. Install specific dependencies as needed.

pip install "vhrharmonize[cloud]"
pip install "vhrharmonize[py6s]"
pip install "vhrharmonize[flaash]"
pip install "vhrharmonize[orthorectification]"
pip install "vhrharmonize[pansharpen]"
pip install "vhrharmonize[align]"
pip install "vhrharmonize[radiometric-normalization]"
pip install "vhrharmonize[docs]"
pip install "vhrharmonize[all]"

Install from source

1. Create and activate a conda environment.

conda create -n vhrharmonize -c conda-forge gdal python=3.11
conda activate vhrharmonize

1. Clone the repository.

git clone https://github.com/cankanoa/vhrharmonize.git
cd vhrharmonize

1. Install the default packages.

pip install -e '.[defaults]'

1. Install specific dependencies as needed.

pip install -e ".[cloud]"
pip install -e ".[py6s]"
pip install -e ".[flaash]"
pip install -e ".[orthorectification]"
pip install -e ".[pansharpen]"
pip install -e ".[align]"
pip install -e ".[radiometric-normalization]"
pip install -e ".[docs]"
pip install -e ".[all]"

Py6S and 6S troubleshooting

This installs Py6S and a packaged 6S executable (from 6s-bin) as Python ependencies. If the packaged executable is unavailable or fails on your platform, run pip install Py6S, then follow the Py6S installation guide to install 6S manually. Pass its executable path using --py6s-executable if its not included in sys.path.

1. Verify the entry points if desired.

vhr-worldview --help
vhr-fetch-modis-water-vapor --help
vhr-flaash --help
vhr-cloudmask-raster --help
vhr-pansharpen-orthos --help
vhr-align-image-pair --help
vhr-orthorectification --help
vhr-radiometric-normalization --help
vhr-py6s --help