update tophu install docs, bump changelog

isce-framework · Oct 10, 2023 · f8695ee · f8695ee
1 parent e1dbfac
commit f8695ee
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,6 @@
-# [Unreleased](https://github.com/isce-framework/dolphin/compare/v0.5.0...main)
+# [Unreleased](https://github.com/isce-framework/dolphin/compare/v0.5.1...main)
+
+# [v0.5.1](https://github.com/isce-framework/dolphin/compare/v0.5.0...v0.5.1)
 
 **Added**
 - `stitch_and_unwrap.run` returns the stitch PS mask

diff --git a/README.md b/README.md
@@ -19,10 +19,11 @@ mamba install -c conda-forge dolphin
 (Note: [using `mamba`](https://mamba.readthedocs.io/en/latest/mamba-installation.html#mamba-install) is recommended for conda-forge packages, but miniconda can also be used.)
 
 
-`dolphin` has the ability to unwrap interferograms, but requires the optional dependency of `isce3` to use the python bindings to [SNAPHU](https://web.stanford.edu/group/radar/softwareandlinks/sw/snaphu/).
-To install both dolphin and isce3 through conda-forge, run
+`dolphin` has the ability to unwrap interferograms using `isce3`'s python bindings to [SNAPHU](https://web.stanford.edu/group/radar/softwareandlinks/sw/snaphu/).
+It is also integrated with [`tophu`](https://github.com/isce-framework/tophu) to unwrap large interferograms in parallel tiles at multiple resolution.
+To install both dolphin and tophu through conda-forge, run
 ```bash
-mamba install -c conda-forge isce3 dolphin
+mamba install -c conda-forge tophu dolphin
 ```
 
 

diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -7,6 +7,12 @@
 mamba install -c conda-forge dolphin
 ```
 
+`dolphin` has the ability to unwrap interferograms using `isce3`'s python bindings to [SNAPHU](https://web.stanford.edu/group/radar/softwareandlinks/sw/snaphu/).
+It is also integrated with [`tophu`](https://github.com/isce-framework/tophu) to unwrap large interferograms in parallel tiles at multiple resolution.
+To install both dolphin and tophu through conda-forge, run
+```bash
+mamba install -c conda-forge tophu dolphin
+```
 
 ## Usage