raider-docs's Introduction

Raytracing Atmospheric Delay Estimator for RADAR - RAiDER

RAiDER is a package in Python which contains tools to calculate tropospheric corrections for Radar using a raytracing implementation. Its development was funded under the NASA Sea-level Change Team (NSLCT) program, the Earth Surface and Interior (ESI) program, and the NISAR Science Team (NISAR-ST) (NTR-51433). U.S. Government sponsorship acknowledged.

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

Getting Started

Quick Start

To get started, run the following lines in a terminal:

conda env create --name RAiDER  -c conda-forge raider jupyterlab
conda activate RAiDER

Then download or clone this repository to your working directory, and run

jupyter lab

navigate to one of the tutorial notebooks, and open it.

Other ways to install
Defining Custom Weather Models

Tutorials

Pandas tutorial for GNSS delay manipulation
RAiDER tutorial
RAiDER library access in Python
Tutorial downloading GNSS tropospheric delays
raiderStats tutorial

raider-docs's People

Contributors

Stargazers

Watchers

raider-docs's Issues

GNSS notebook

Does this need an update based on your change?

Updating the front-facing README

@dbekaert I've updated the documention on using RAiDER. Most of the material on the front-page readme is now not needed, as that is included in the "Getting Started ..." notebook.
We may want to move the installation info from the Getting Started notebook to the main README, or even put it in both places. The nice thing about the notebook is that right now it takes the user through the complete process of getting started, so could be used in a workshop etc.
Also may want to move the info on accessing weather model data to it's own README or notebook, or perhaps it is fine here.
There may need to be some additional details worked out in the Getting Started notebook.
I put a triple-star (***) anywhere I need to fill in more details or check a statement.