opera-utils 0.9.0

Miscellaneous utilities for working with OPERA data products

opera-utils

Install

The opera_utils package is available on PyPI and conda-forge:

pip install opera-utils

# if mamba is not already installed: conda install -n base mamba
mamba install -c conda-forge opera-utils

(Note: using mamba is recommended for conda-forge packages, but miniconda can also be used.)

While not required for all, some utilities use the GDAL package, which can be installed most easily on conda-forge:

mamba env update --file environment-geo.yml

Setup for Developers

To contribute to the development of opera-utils, you can fork the repository and install the package in development mode. We encourage new features to be developed on a new branch of your fork, and then submitted as a pull request to the main repository.

To install locally,

1. Download source code:

git clone https://github.com/opera-adt/opera-utils.git && cd opera-utils

2. Install dependencies:

mamba env create --name my-opera-env --file environment.yml
mamba install gdal

3. Install the source in editable mode:

mamba activate my-opera-env
python -m pip install -e .

The extra packages required for testing and building the documentation can be installed:

# Run "pip install -e" to install with extra development requirements
python -m pip install -e ".[docs,test]"

We use pre-commit to automatically run linting and formatting:

# Get pre-commit hooks so that linting/formatting is done automatically
pre-commit install

This will set up the linters and formatters to run on any staged files before you commit them.

After making functional changes, you can rerun the existing tests and any new ones you have added using:

python -m pytest