run_hyp3

This script is for automatically running all steps needed to submit, download, and prepare HyP3 multiburst interferograms for ingestion into MintPy, then running MintPy with default settings. It uses scripts from the repos merge_hyp3 and download_hyp3.

Table of Contents

• Installation

• Usage

• Contributing

• License

• Installation

1. Clone the repository:

git clone https://github.com/tshreve/run_hyp3_workflow.git
cd run_hyp3_workflow/

2. Install dependencies for download using run_hyp3_dependencies.txt in a conda environment:

echo 'dask
hyp3_sdk
asf_search
gdal
numpy
mintpy' > run_hyp3_dependencies.txt

conda create --name run_hyp3 --file run_hyp3_dependencies.txt
conda activate run_hyp3

3. Update Earthdata login credentials in ~/.netrc file:

echo 'machine urs.earthdata.nasa.gov
    login YOUR_USERNAME
    password YOUR_PASSWORD' >> ~/.netrc

Usage

To run, use the following commands:

1. To submit jobs to HyP3:
   

./run_hyp3_workflow.sh 1 job_name min_lon max_lon min_lat max_lat orb max_temp_base_days date1 date2

where:
job_name : HyP3 job name
min_lon : Minimum longitude of AOI
max_lon : Maximum longitude of AOI
min_lat : Minimum latitude of AOI
max_lat : Maximum latitude of AOI
orb : Relative orbit (can be obtained through the ASF Vertex Data Search)
max_temp_base_days : maximum temporal baseline for nearest neighbor pairs
date1 : start date
date2 : end date

You will be prompted to check the created text file to ensure you are submitting the correct dates.
2. Once submitted jobs are finished, download and prepare HyP3 interferograms, and run MintPy with default settings:

./run_hyp3_workflow.sh 2 job_name data_folder mintpy_folder

where:
ref_Scene_ID : Reference scene ID
sec_Scene_ID : Secondary scene ID
job_name: HyP3 job name
data_folder : folder to download interferograms
mintpy_folder : folder to run MintPy

Contributing

Contributions are encouraged! I will do my best to continue updating this script, but if you've found ways to improve it on your own, feel free to create a PR using the following:

1. Fork the repository.
2. Create a new branch: git checkout -b feature-name.
3. Make your changes.
4. Push your branch: git push origin feature-name.
5. Create a pull request.

Ideas for increased functionality are also welcome. Thanks to all who are helping to make InSAR more accessible, in particular those who maintain MintPy, asf_search, and hyp3_sdk!

License

Please see license information for MintPy, asf_search, and hyp3_sdk.