Installation¶

openseppo requires MacOS or Linux and python>=3.12.

NOTE: On first use of the CLI tools, expect a short delay while the python libraries and earthaccess token are installed.

For best performance (and to be nice to reduce egress costs), use the tools on an AWS ec2 instance (32GB to 64GB RAM) in us-west-2.

pip (From PyPI)¶

Use pip if mamba/conda is not an option or not working.

pip install "openseppo[nisar]" matplotlib

conda/mamba¶

Create a new environment with all dependencies¶

mamba env create -n openseppo -c conda-forge \
    openseppo \
    aria2 \
    matplotlib
conda activate openseppo

Install into an existing environment¶

conda activate myenv
mamba install -c conda-forge openseppo aria2 matplotlib

From a local clone (development / editable install)¶

git clone https://github.com/EarthBigData/openSEPPO.git
cd openSEPPO
pip install -e ".[nisar]"

The [nisar] extra installs the full dependency stack required for all NISAR tools (seppo_nisar_rslc_convert, seppo_nisar_gcov_convert, seppo_nisar_gslc_convert, seppo_nisar_coherence, seppo_earthaccess_credentials): earthaccess, h5py, numpy, rasterio, s3fs, xarray, scipy, pyproj.

The base install (no extra) provides only seppo_nisar_search (CMR search via requests, no Earthdata login required for public metadata queries).

aria2¶

aria2 is a multi-connection download accelerator used to cache remote HDF5 file https:// urls quickly. It is a system-level tool and must be installed via conda/mamba (or your OS package manager) rather than pip.

When installing openseppo via pip, install aria2 separately via conda or your OS package manager:

# conda/mamba
mamba install -c conda-forge aria2

# macOS (Homebrew)
brew install aria2

# Linux (apt)
sudo apt install aria2

NASA Earthdata credentials¶

All tools that access NISAR data require a free NASA Earthdata account. It is advantageous to store your credentials in ~/.netrc:

machine urs.earthdata.nasa.gov
    login <your_username>
    password <your_password>

Or use the interactive login prompt that earthaccess shows automatically on first use. To pre-generate and cache the bearer token used for HTTPS downloads:

seppo_earthaccess_credentials -t

Installed CLI tools¶

Command	Description
`seppo_nisar_rslc_convert`	Subset NISAR RSLC HDF5 for isce3/GAMMA/SEPPO interferometric processing
`seppo_nisar_gcov_convert`	Convert NISAR GCOV HDF5 to COG/GTiff/HDF5 with subsetting and time-series stacking
`seppo_nisar_gcov_convert_S`	S-band variant of `seppo_nisar_gcov_convert` (Beta release)
`seppo_nisar_gslc_convert`	Convert NISAR GSLC HDF5 to COG/GTiff/HDF5 with subsetting
`seppo_nisar_coherence`	Compute interferometric coherence from co-registered GSLC files
`seppo_nisar_search`	Search NISAR products via NASA Earthdata CMR
`seppo_earthaccess_credentials`	Manage Earthdata S3 credentials and bearer token