ARIA-tools is an open-source package in Python which contains tools to manipulate standard InSAR products from Sentinel-1 (ARIA GUNW-S1) and NISAR (NISAR_L2_GUNW). This software is open source under the terms of the Apache 2.0 License. Its development was funded under the ROSES awards from the NASA Sea-level Change Team (NSLCT) program, the Earth Surface and Interior (ESI) program, and under the NISAR Science Team (NISAR-ST) program.

ARIA tools includes support for:

• ARIA Geocoded Unwrapped Interferogram from Sentinel-1 (GUNW-S1) can be downloaded for free from the ASF DAAC vertex page selecting "ARIA S1 GUNW" under "datasets". Users can also request free on-demand products through the ASF on-demand system. These products are added to the standard product archive. A log-on using the NASA Earthdata credentials is required to order new or download data from the archive. Product Specification Document.
• NISAR Gecoded Unwrapped Interferogram products (NISAR_L2_GUNW) can be downloaded for free from the ASF DAAC vertex page selecting "NISAR" under "datasets" and selecting "GUNW" under the filter criteria. Product Specification document.

The ARIA-tools package includes functionality to crop/merge data and meta-data layers for multiple standard products, extraction of data and meta-data layers from these products, and the set-up and the preparation for time-series.

Actual time-series processing is not supported in ARIA-tools. However, outputs are compatible with third-party time-series InSAR packages such the "Miami INsar Time-series software in PYthon" (MintPy).

1. Software Dependencies
2. Installation
   • Conda
   • Installing a stable release from conda
   • Installing the latest development branch
   • Other installation options
   • ARIA-tools with support for S3 virtual data access
3. Running ARIA-tools
   • Commandline download of GUNW Products
   • Manipulating GUNW Products
   • Baseline and quality control plots for GUNW Products
   • Time-series set-up of GUNW Products
4. Documentation
5. Citation
6. Contributors and community contributions

Below we list the key dependencies for ARIA-tools. See environment.yml for complete list.

* Python >= 3.8  (3.9 preferred)
* [PROJ 4](https://github.com/OSGeo/proj) github) >= 6.0
* [GDAL](https://www.gdal.org/) and its Python bindings >= 3.7.0

* [SciPy](https://www.scipy.org/)
* [netcdf4](http://unidata.github.io/netcdf4-python/netCDF4/index.html)
* [requests](https://2.python-requests.org/en/master/)
* [asf_search](https://github.com/asfadmin/Discovery-asf_search) >=12.0.1

* py3X-jupyter
* py3X-jupyter_client
* py3X-jupyter_contrib_nbextensions
* py3X-jupyter_nbextensions_configurator
* py3X-hide_code
* py3X-RISE

ARIA-tools has been tested on the following system:

• Linux v.7 and up

Below we demonstrate how to build and setup an environment from scratch through Linux through a TCSH shell.

ARIA-tools package can be easily installed and used after the dependencies are installed and activated.

Conda is a cross-platform way to use Python that allows you to setup and use "virtual environments," which allows for the easy installation and management of all of the required dependencies. We recommend using the Miniforge conda environment manager, which uses conda-forge as its default code repo. Alternatively, see here for help installing Anaconda and here for installing Miniconda.

Below we outline the different steps for setting up the ARIA-tools while leveraging Miniforge for installation of the requirements.

Run the commands below to download and setup your Miniforge environment manager:

cd ~/tools
wget "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh"

# specify a new directory when prompted
bash "Miniforge3-$(uname)-$(uname -m).sh" -b -p miniforge
miniforge/bin/mamba init tcsh

# reset shell
csh

To install a stable release of aria-tools from conda, refer to these instructions and disregard the rest of the installation section.

# OPTIONAL: create/activate new env
# highly recommended to avoid potential conflicts with other packages
conda create --name ARIA-tools-conda
conda activate ARIA-tools-conda

# install aria tools
mamba install aria-tools

To access and install the latest development branch from github, refer instead to these installation instructions.

Run the commands below to download/clone the ARIA-tools package to your local directory:

cd ~/tools
git clone https://github.com/aria-tools/ARIA-tools.git
cd ARIA-tools

Run the commands below to install dependencies to a new conda environment ARIA-tools and activate it. Make sure to activate your environment each time you open a new session:

mamba env create -f environment.yml
conda activate ARIA-tools

We have included a setup.py script which allows for easy installation and setting up the ARIA-tools package itself (python and command line tools).

python -m pip install -e .

If not using the setup.py, users should compile third-party packages manually and ensure ARIA-tools and dependencies are included on their PATH and PYTHONPATH. For TCSH shell this can be done as follows (replace {$PWD}/tools/ARIAtools to the location where you have cloned the ARIAtools repository):

setenv PYTHONPATH ${PYTHONPATH}:{$PWD}/tools/ARIAtools
setenv PATH ${PATH}:${PWD}/tools/bin

To avoid potential issues associated with dependencies when cloning new ARIA-tools commits, it is advised to regularly maintain your conda environment as so (making sure to adjust the conda environment argument name --name ARIA-tools as appropriate):

mamba env update --name ARIA-tools --file environment.yml --prune

GNU Parallel (https://www.gnu.org/software/parallel/) will write output to stdout that requests that the user cite their paper. We can use this command to suppress this output:

echo 'will cite' | parallel --citation

The following pages might be of use to those trying to build third party packages from source.

• Installing dependencies from source on linux
• Installing dependencies from source on mac

GDAL Virtual File Systems capabilities (vsicurl) can be leveraged in ARIA-tools to avoid download of product during processing.

Minimum requirements:

* [GDAL](https://www.gdal.org/) and its Python bindings >= 3.8
* Linux kernel >=4.3 
* libnetcdf >=4.5 

A '~/.netrc' file with earthdata credential included

echo "machine urs.earthdata.nasa.gov login myUsername password myPassword" > ~/.netrc
chmod 600 ~/.netrc

In addition, users should set the following environment variables:

export GDAL_HTTP_COOKIEFILE=/tmp/cookies.txt
export GDAL_HTTP_COOKIEJAR=/tmp/cookies.txt
export VSI_CACHE=YES

The ARIA-tools scripts are highly modulized in Python and therefore allows for building your own processing workflow. Below, we show how to call some of the functionality. For detailed documentation, examples, and Jupyter notebooks see the ARIA-tools-docs repository. We welcome the community to contribute other examples on how to leverage the ARIA-tools (see here for instructions).

ARIA GUNW-S1/NISAR_L2_GUNW products can be downloaded through the commandline using the ariaDownload.py program, which wraps around the ASF DAAC api.

ARIA GUNW-S1/NISAR_L2_GUNW products can be manipulated (cropped, stitched, extracted) using the ariaExtract.py program.

ARIA GUNW-S1 quality and baseline plots for spatial-temporal contiguous interferograms can be made using the ariaPlot.py program.

ARIA GUNW-S1/NISAR_L2_GUNW time-series set-up with spatial-temporal contiguous unwrapped interferograms and coherence can be done using the ariaTSsetup.py program.

See the ARIA-tools-docs repository for all documentation and Jupyter Notebook Tutorials.

Buzzanga, B., Bekaert, D. P. S., Hamlington, B. D., & Sangha, S. S. (2020). Towards Sustained Monitoring of Subsidence at the Coast using InSAR and GPS: An Application in Hampton Roads, Virginia. Geophysical Research Letters, 47, e2020GL090013. https://doi.org/10.1029/2020GL090013

• David Bekaert
• Simran Sangha
• Emre Havazli
• Brett Buzzanga
• Alexander Fore
• Marin Govorcin
• Charles Marshak
• Joseph Kennedy
• other community members

We welcome community contributions. For instructions see here.