Dolphin

Dolphin: A Python package for large-scale InSAR PS/DS processing - Published in JOSS (2024)

https://github.com/isce-framework/dolphin

Science Score: 100.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 6 DOI reference(s) in README and JOSS metadata
✓
Academic publication links
Links to: joss.theoj.org
✓
Committers with academic emails
3 of 8 committers (37.5%) from academic institutions
○
Institutional organization owner
✓
JOSS paper metadata
Published in Journal of Open Source Software

Keywords

deformation geoscience geospatial-processing insar phase-linking remote-sensing squeesar time-series

Keywords from Contributors

mesh hydrology energy-system exoplanet hydraulic-modelling polygon gravitational-lensing ode

Last synced: 4 months ago · JSON representation ·

Repository

InSAR phase linking library for creating surface displacement maps using persistent scatterer (PS) and distributed scatterer (DS) processing

Basic Info

Host: GitHub
Owner: isce-framework
License: other
Language: Python
Default Branch: main
Homepage: https://dolphin-insar.readthedocs.io
Size: 64.8 MB

Statistics

Stars: 101
Watchers: 10
Forks: 28
Open Issues: 26
Releases: 63

Topics

deformation geoscience geospatial-processing insar phase-linking remote-sensing squeesar time-series

Created over 3 years ago · Last pushed 4 months ago

Metadata Files

Readme Changelog Contributing License Citation

dolphin

High resolution wrapped phase estimation for Interferometric Synthetic Aperture Radar (InSAR) using combined persistent scatterer (PS) and distributed scatterer (DS) processing.

Install

dolphin may be installed via conda-forge:

```bash

if mamba is not already installed, see here: https://mamba.readthedocs.io/en/latest/

mamba install -c conda-forge dolphin ```

It is also available via PyPI and may be pip-installed on some platforms, such as Google's Colab. However, certain dependencies (e.g. GDAL) are more easily set up through conda.

dolphin has the ability to unwrap interferograms using several options, which can be toggled using the unwrap_method configuration option:

snaphu-py, a lightweight Python bindings to SNAPHU. Available on both pip and conda.
isce3's python bindings to SNAPHU, PHASS, or ICU
spurt, a 3D unwrapper, implementing the Extended Minimum Cost Flow (ECMF) algorithm
tophu, a multi-scale unwrapper designed to unwrap large interferograms in parallel tiles at multiple resolution.

These may be installed via conda or (in the case of snaphu-py) pip.

To install locally:

Download source code:

bash git clone https://github.com/isce-framework/dolphin.git && cd dolphin

Install dependencies:

bash mamba env create --file conda-env.yml

or if you have an existing environment:

bash mamba env update --name my-existing-env --file conda-env.yml

Install dolphin via pip:

bash conda activate dolphin-env python -m pip install .

Dolphin can also take advantage of CUDA-compatible GPUs for faster processing. See the docs for installation instructions and configuration.

Usage

The main entry point for configuring and running workflows the dolphin command line tool:

dolphin config: create a workflow configuration file.
dolphin run : run the workflow using this file.

Example usage:

```bash dolphin config --slc-files /path/to/slcs/*tif

OR: to make a coarser output 4x as quickly:

dolphin config --slc-files /path/to/slcs/*tif --strides 2 2

dolphin run dolphin_config.yaml ```

The config command creates a YAML file (by default dolphin_config.yaml in the current directory). If you'd like to see an empty YAML with all defaults filled in, you can run dolphin config --print-empty, which creates a sample file like the one here

The only required inputs for the workflow are the paths to the coregistered SLC files (in either geographic or radar coordinates). If the SLC files are spread over multiple files, you can either

use the --slc-files option with a bash glob pattern, (e.g. dolphin config --slc-files merged/SLC/*/*.slc would match the ISCE2 stack processor output )
Store all input SLC files in a text file delimited by newlines (e.g. my_slc_list.txt), and give the name of this text file prefixed by the @ character (e.g. dolphin config --slc-files @my_slc_list.txt)

The full set of options is written to the configuration file; you can edit this file, or you can see which commonly tuned options by are changeable running dolphin config --help.

Building and running via Docker

dolphin can also be run using Docker. You can use the one built on Github, or build it locally using the script

bash ./docker/build-docker-image.sh

Citation

If you use dolphin in your research, please cite:

Staniewicz et al., (2024). Dolphin: A Python package for large-scale InSAR PS/DS processing. Journal of Open Source Software, 9(103), 6997, https://doi.org/10.21105/joss.06997

Contributing

We welcome many forms of contributing, including testing, bug reports, and documentation fixes. If you think you've found a problem, please let us know! You can raise an issue on the repository, where there are templates for Bug Reports and Feature Requests. If you have a general question of idea, feel free to raise it in the Discussions page.

For more detailed guidance on setting up a development environment, including how make and test changes to the code, see Contributing to Dolphin.

For more general Q&A, please use the Discussions page.

License

This software is licensed under your choice of BSD-3-Clause or Apache-2.0 licenses. See the accompanying LICENSE file for further details.

SPDX-License-Identifier: BSD-3-Clause OR Apache-2.0

Owner

Name: isce-framework
Login: isce-framework
Kind: organization

Repositories: 5
Profile: https://github.com/isce-framework

JOSS Publication

Dolphin: A Python package for large-scale InSAR PS/DS processing

Published

November 13, 2024

DOI

10.21105/joss.06997

Volume 9, Issue 103, Page 6997