Skip to main content

Decorrelation

A InSAR postprocessing tool in big data era

This package provide functions for InSAR post-processing which refers as processing after SAR images co-registration and geocoding. The functions include PS/DS identification, coherence matrix estimation, phase linking etc.

What make Decorrelation different?

  • Decorrelation implements state-of-art InSAR techniques. Currently it includes advanced PS/DS identification, phase linking and deep-learning-based methods that performs much better than the classic one.
  • Decorrelation runs fast. As many of InSAR processing are pixel-wise or patch-wise manipulation, Most of Decorrelation functions are implemented with well-optimized GPU code. Furthermore, with the support of Dask, Decorrelation can be runed on multi-GPUs to further accelerate the processing and get rid of the limitation of GPU memory.
  • Decorrelation support interative big data visulization. Since the SAR data volume increase dramatically recently and in near future, not only the processing time is a concern (which is largely solved as Decorrelation runs so fast!), the inspection on the images is a problem. Decorrelation provide Datashader-based functions for accurate, interative representation on even largest time series InSAR data.

Please refer to the Documentation for detailed usage.

Warning

Due to the heavy dependence on CuPy and CUDA, this package only works on device with Nivida GPU.

Warning

This package is under intensive development. API is subjected to change without any noticement.

Install

Because of GPU driver and CUDA Version Compatibility, there is no simple solution for CUDA related packages installation. Users need to successfully install cupy and dask_cuda first.

Here is some tips for installing them. Generally, the cuda driver is alrealy installed and maintained by the system administrator. Users only need to determine the right cudatoolkit version. Frist run

nvidia-smi

It will prints something like:

...
+-----------------------------------------------------------------------------+
| NVIDIA-SMI 525.105.17   Driver Version: 525.105.17   CUDA Version: 12.0     |
|-------------------------------+----------------------+----------------------+
...

The CUDA Version is the maxminum cudatoolkit version that supported by the current CUDA driver. Here we use version 11.8 as an example. Then you can install the needed cudatoolkit, cupy, dask_cuda by:

conda install -c "nvidia/label/cuda-11.8.0" cuda-toolkit
conda install -c conda-forge cupy cuda-version=11.8
conda install -c rapidsai -c conda-forge -c nvidia dask-cuda cuda-version=11.8

Then

With conda:

conda install -c conda-forge decorrelation

Or with pip:

pip install decorrelation

In development mode:

git clone git@github.com:kanglcn/decorrelation.git ./decorrelation
cd ./decorrelation
pip install -e '.[dev]'

How to use

Read the software architecture first.

Contact us

  • Most discussion happens on GitHub. Feel free to open an issue or comment on any open issue or pull request.
  • use github discussions to ask questions or leave comments.

Contribution

  • Pull requests are welcomed! Before making a pull request, please open an issue to talk about it.
  • We have notice many excellent open-source packages are rarely paid attention to due to lack of documentation. The package is developed with the nbdev, a notebook-driven development platform. Developers only need to simply write notebooks with lightweight markup and get high-quality documentation, tests, continuous integration, and packaging automatically.

Metadata

Release files for decorrelation 0.5.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for decorrelation 0.5.1
File Size Uploaded Provenance Actions
decorrelation-0.5.1.tar.gz 44.6 kB Without provenance Details for decorrelation-0.5.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for decorrelation 0.5.1
File Interpreter ABI Platform Actions
decorrelation-0.5.1-py3-none-any.whl Python 3 none any Details for decorrelation-0.5.1-py3-none-any.whl

Total release size: 95.1 kB

Release files / decorrelation-0.5.1.tar.gz

Download URL decorrelation-0.5.1.tar.gz
Size 44.6 kB
Tags Source
SHA-256 checksum
How to use checksums
e71598b04516374730f026d02cca28c73dfe32285ebb2fbd8af0697bd2bd9614
BLAKE2b-256 checksum
How to use checksums
ef2b9eecaa53566714ad2f9b67112caa395737ebf489be5dec54284fa64ece57
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.11.7

Release files / decorrelation-0.5.1-py3-none-any.whl

Download URL decorrelation-0.5.1-py3-none-any.whl
Size 50.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1d55b14af0ab94bc5bd0e1cb2c0f7aaf04fb5c71dcb0cffb98d3dc3314aef56c
BLAKE2b-256 checksum
How to use checksums
dd370ea5062fa2485e0df568111862cbb3a72dea9bad3b177aa7cce33309e99c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.11.7

Security for decorrelation 0.5.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page