{"id":34681586,"url":"https://github.com/isce-framework/dolphin","last_synced_at":"2025-12-24T21:12:02.213Z","repository":{"id":49741706,"uuid":"516175067","full_name":"isce-framework/dolphin","owner":"isce-framework","description":"InSAR phase linking library for creating surface displacement maps using persistent scatterer (PS) and distributed scatterer (DS) processing","archived":false,"fork":false,"pushed_at":"2025-12-15T18:44:56.000Z","size":68528,"stargazers_count":113,"open_issues_count":27,"forks_count":28,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-12-22T00:38:05.579Z","etag":null,"topics":["deformation","geoscience","geospatial-processing","insar","phase-linking","remote-sensing","squeesar","time-series"],"latest_commit_sha":null,"homepage":"https://dolphin-insar.readthedocs.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/isce-framework.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-07-21T00:37:03.000Z","updated_at":"2025-12-11T02:58:21.000Z","dependencies_parsed_at":"2023-12-18T22:22:14.773Z","dependency_job_id":"67e8ecf9-c1a0-4f65-ac29-aa2ed4854dc2","html_url":"https://github.com/isce-framework/dolphin","commit_stats":{"total_commits":486,"total_committers":6,"mean_commits":81.0,"dds":0.08230452674897115,"last_synced_commit":"082360426bbc1f5fd9450ecdb39cb5c1bc66ad5a"},"previous_names":["isce-framework/dolphin","opera-adt/dolphin"],"tags_count":69,"template":false,"template_full_name":null,"purl":"pkg:github/isce-framework/dolphin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/isce-framework%2Fdolphin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/isce-framework%2Fdolphin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/isce-framework%2Fdolphin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/isce-framework%2Fdolphin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/isce-framework","download_url":"https://codeload.github.com/isce-framework/dolphin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/isce-framework%2Fdolphin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28008543,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-12-24T02:00:07.193Z","response_time":83,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["deformation","geoscience","geospatial-processing","insar","phase-linking","remote-sensing","squeesar","time-series"],"created_at":"2025-12-24T21:12:01.806Z","updated_at":"2025-12-24T21:12:02.194Z","avatar_url":"https://github.com/isce-framework.png","language":"Python","readme":"# dolphin\n\n[![Pytest and build docker image](https://github.com/isce-framework/dolphin/actions/workflows/test-build-push.yml/badge.svg?branch=main)](https://github.com/isce-framework/dolphin/actions/workflows/test-build-push.yml)\n[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/isce-framework/dolphin/main.svg)](https://results.pre-commit.ci/latest/github/isce-framework/dolphin/main)\n[![Documentation Status][rtd-badge]][rtd-link]\n[![Conda-Forge][conda-badge]][conda-link]\n[![PyPI platforms][pypi-platforms]][pypi-link]\n[![GitHub Discussion][github-discussions-badge]][github-discussions-link]\n[![DOI](https://joss.theoj.org/papers/10.21105/joss.06997/status.svg)](https://doi.org/10.21105/joss.06997)\n\n\u003c!-- prettier-ignore-start --\u003e\n[conda-badge]:              https://img.shields.io/conda/vn/conda-forge/dolphin\n[conda-link]:               https://github.com/conda-forge/dolphin-feedstock\n[pypi-link]:                https://pypi.org/project/dolphin/\n[pypi-platforms]:           https://img.shields.io/pypi/pyversions/dolphin\n[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions\u0026message=Ask\u0026color=blue\u0026logo=github\n[github-discussions-link]:  https://github.com/isce-framework/dolphin/discussions\n[rtd-badge]:                https://readthedocs.org/projects/dolphin-insar/badge/?version=latest\n[rtd-link]:                 https://dolphin-insar.readthedocs.io/en/latest/?badge=latest\n\u003c!-- prettier-ignore-end --\u003e\n\nHigh resolution wrapped phase estimation for Interferometric Synthetic Aperture Radar (InSAR) using combined persistent scatterer (PS) and distributed scatterer (DS) processing.\n\n\u003c!-- DeformatiOn Land surface Products in High resolution using INsar --\u003e\n\n## Install\n\n`dolphin` may be installed via conda-forge:\n\n```bash\n# if mamba is not already installed, see here: https://mamba.readthedocs.io/en/latest/\nmamba install -c conda-forge dolphin\n```\n\nIt is also available via [`PyPI`](https://pypi.org/project/dolphin/) 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`.\n\n`dolphin` has the ability to unwrap interferograms using several options, which can be toggled using the `unwrap_method` configuration option:\n\n1. [`snaphu-py`](https://github.com/isce-framework/snaphu-py), a lightweight Python bindings to [SNAPHU](https://web.stanford.edu/group/radar/softwareandlinks/sw/snaphu/). Available on both pip and conda.\n2. [`isce3`](https://github.com/isce-framework/isce3)'s python bindings to SNAPHU, PHASS, or ICU\n3. [`spurt`](https://github.com/isce-framework/spurt), a 3D unwrapper, implementing the Extended Minimum Cost Flow (ECMF) algorithm\n4. [`tophu`](https://github.com/isce-framework/tophu), a multi-scale unwrapper designed to unwrap large interferograms in parallel tiles at multiple resolution.\n\n\nThese may be installed via conda or (in the case of `snaphu-py`) pip.\n\nTo install locally:\n\n1. Download source code:\n\n```bash\ngit clone https://github.com/isce-framework/dolphin.git \u0026\u0026 cd dolphin\n```\n\n2. Install dependencies:\n\n```bash\nmamba env create --file conda-env.yml\n```\n\nor if you have an existing environment:\n\n```bash\nmamba env update --name my-existing-env --file conda-env.yml\n```\n\n3. Install `dolphin` via pip:\n\n```bash\nconda activate dolphin-env\npython -m pip install .\n```\n\nDolphin can also take advantage of CUDA-compatible GPUs for faster processing. [See the docs](https://dolphin-insar.readthedocs.io/en/latest/gpu-setup) for installation instructions and configuration.\n\n## Usage\n\nThe main entry point for configuring and running workflows the `dolphin` command line tool:\n\n1. `dolphin config`: create a workflow configuration file.\n2. `dolphin run` : run the workflow using this file.\n\nExample usage:\n\n```bash\ndolphin config --slc-files /path/to/slcs/*tif\n# OR: to make a coarser output 4x as quickly:\n# dolphin config --slc-files /path/to/slcs/*tif --strides 2 2\ndolphin run dolphin_config.yaml\n```\n\nThe `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](https://raw.githubusercontent.com/isce-framework/dolphin/refs/heads/main/docs/sample_dolphin_config.yaml)\n\nThe only required inputs for the workflow are the paths to the coregistered SLC files (in either geographic or radar coordinates).\nIf the SLC files are spread over multiple files, you can either\n\n1. 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](https://github.com/isce-framework/isce2/tree/main/contrib/stack) )\n\n1. 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`)\n\nThe 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`.\n\n## Building and running via Docker\n\n`dolphin` can also be run using Docker. You can use the one built on [Github](https://github.com/isce-framework/dolphin/pkgs/container/dolphin), or build it locally using the script\n\n```bash\n./docker/build-docker-image.sh\n```\n\n## Citation\n\nIf you use `dolphin` in your research, please cite:\n\nStaniewicz et al., (2024). Dolphin: A Python package for large-scale InSAR PS/DS processing.\nJournal of Open Source Software, 9(103), 6997, https://doi.org/10.21105/joss.06997\n\n## Contributing\n\nWe 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](https://github.com/isce-framework/dolphin/issues) 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](https://github.com/isce-framework/dolphin/discussions) page.\n\nFor more detailed guidance on setting up a development environment, including how make and test changes to the code, see [Contributing to Dolphin](CONTRIBUTING.md).\n\nFor more general Q\u0026A, please use the [Discussions](https://github.com/isce-framework/dolphin/discussions) page.\n\n## License\n\nThis software is licensed under your choice of BSD-3-Clause or Apache-2.0 licenses. See the accompanying LICENSE file for further details.\n\nSPDX-License-Identifier: BSD-3-Clause OR Apache-2.0\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fisce-framework%2Fdolphin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fisce-framework%2Fdolphin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fisce-framework%2Fdolphin/lists"}