Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/insarlab/PyAPS
Python-based Atmospheric Phase Screen
https://github.com/insarlab/PyAPS
era5 geodesy insar troposphere
Last synced: 2 days ago
JSON representation
Python-based Atmospheric Phase Screen
- Host: GitHub
- URL: https://github.com/insarlab/PyAPS
- Owner: insarlab
- License: gpl-3.0
- Created: 2019-04-08T16:55:51.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-06-27T12:22:53.000Z (5 days ago)
- Last Synced: 2024-06-27T12:31:31.855Z (5 days ago)
- Topics: era5, geodesy, insar, troposphere
- Language: Python
- Homepage:
- Size: 81.2 MB
- Stars: 59
- Watchers: 4
- Forks: 23
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-sar - PyAPS - Python based Atmospheric Phase Screen Estimation. (Noise Correction Software)
README
[](https://www.python.org/)
[](https://circleci.com/gh/insarlab/PyAPS)
[](https://anaconda.org/conda-forge/pyaps3)
[](https://github.com/insarlab/PyAPS/releases)
[](https://github.com/insarlab/PyAPS/blob/main/LICENSE)
[](https://doi.org/10.1029/2011GL048757)
## PyAPS - Python based Atmospheric Phase Screen estimation
This python 3 module estimates differential phase delay maps due to the stratified atmosphere for correcting radar interferograms. It is rewritten in Python 3 language from PYAPS source code and adapted for ECMWF's ERA-5 corrections.
WARNING: The current version does not work with NARR and MERRA datasets. Contributions are welcomed.
This is research code provided to you "as is" with NO WARRANTIES OF CORRECTNESS. Use at your own risk.
### 1. Installation
#### a. Install the released version [recommended]
`pyaps3` is available on the [conda-forge](https://anaconda.org/conda-forge/pyaps3) channel, [PyPI](https://pypi.org/project/pyaps3/) and the main archive of the [Debian](https://tracker.debian.org/pkg/pyaps3) GNU/Linux OS. The released version can be installed via `conda` as:
```bash
conda install -c conda-forge pyaps3
```
or via `pip` as:
```bash
pip install pyaps3
```
or via `apt` (or other package managers) for [Debian-derivative OS](https://wiki.debian.org/Derivatives/Census) users, including [Ubuntu](https://ubuntu.com), as:
```bash
apt install python3-pyaps3
```
#### b. Install the development version
The development version can be installed via `pip` as:
```bash
pip install git+https://github.com/insarlab/PyAPS.git
```
or build from source manually as:
```bash
git clone https://github.com/insarlab/PyAPS.git
conda install -c conda-forge --file PyAPS/requirements.txt
python -m pip install -e PyAPS
```
Test the installation by running:
```bash
python PyAPS/tests/test_calc.py
```
### 2. Account setup for [ERA5](https://retostauffer.org/code/Download-ERA5/)
ERA5 data set is redistributed over the Copernicus Climate Data Store (CDS). Registration is required for the data access and downloading.
+ [Create a new account](https://cds.climate.copernicus.eu/user/register) on the CDS website if you don't own a user account yet.
+ Create the local file `$HOME/.cdsapirc` and add the following two lines:
```shell
url: https://cds.climate.copernicus.eu/api/v2
key: 12345:abcdefghij-134-abcdefgadf-82391b9d3f
```
where 12345 is your personal user ID (UID), the part behind the colon is your personal API key. More details can be found [here](https://cds.climate.copernicus.eu/api-how-to). Alternatively, you could edit the `model.cfg` file in the package directory, `site-packages/pyaps3` if installed via conda, and fill in the `[CDS]` section.
+ **Make sure** that you accept the data license in the Terms of use on ECMWF website.
+ Test the account setup by running:
```bash
git clone https://github.com/insarlab/PyAPS.git --depth 1
python PyAPS/tests/test_dload.py
```
### 3. Citing this work
The methodology and validation can be found in:
+ Jolivet, R., R. Grandin, C. Lasserre, M.-P. Doin and G. Peltzer (2011), Systematic InSAR tropospheric phase delay corrections from global meteorological reanalysis data, _Geophys. Res. Lett., 38,_ L17311, doi:[10.1029/2011GL048757](https://doi.org/10.1029/2011GL048757).