Notebooks for NISAR Solid Earth Algorithm Theoretical Basis Document

ATBD is a package in Python which contains the NISAR Solid Earth Jupyter notebooks that are to be used for verifying the NISAR L2 Solid Earth Science requirements. Its development started from existing open-source notebooks developed by the MintPy and ARIA-tools teams, with funding support from the NISAR Science Team (NISAR-ST). U.S. Government sponsorship acknowledged.

Copyright (c) 2021, California Institute of Technology ("Caltech"). All rights reserved.

THIS IS RESEARCH CODE PROVIDED TO YOU "AS IS" WITH NO WARRANTIES OF CORRECTNESS. USE AT YOUR OWN RISK.

1. Installation

The dependencies of this ATBD repo is listed in the requirements.txt file. A detailed installation on how to build a working environment using these requirements can be found here.

Notes on GPS code installation.

2. ATBD Jupyter notebooks

The ATBDs for the NISAR Solid Earth L2 requiremetns are included in the xxx folder. A folder breakdown is provided for each requirement.

• Secular Deformation (658)
• Co-Seismic Deformation (660)
• Transient Deformation (663)

3. Implementation Plan

The functional components (building blocks) are briefly summarized and listed in https://github.com/nisar-solid/ATBD/issues/2. For each not-complete funcationality (linked in the summary issue), an independent issue ticket is created for detailed description / discussion and work distribution.

4. Communication & Documentation

• Slack channel: NISAR-ST for quick questions discussions
• GitHub issues and discussions
• Emails always works if preferred
• GitHub wiki is a convenient place to take notes

5. Contributing

We welcome community contributions. Please read our contributing guideline for more information.