Metadata-Version: 2.4
Name: RAiDER
Version: 0.6.0
Summary: Raytracing Atmospheric Delay Estimation for RADAR
Author-email: David Bekaert <david.bekaert@jpl.nasa.gov>, Jeremy Maurer <maurer.jeremy@gmail.com>, Piyush Agram <piyush@descarteslabs.com>, Simran Sangha <simran.s.sangha@jpl.nasa.gov>, Brett Buzzanga <buzzanga@jpl.nasa.gov>
License: Apache License 2.0
Project-URL: homepage, https://github.com/dbekaert/RAiDER
Project-URL: documentation, https://github.com/dbekaert/RAiDER-docs
Project-URL: repository, https://github.com/dbekaert/RAiDER
Project-URL: Bug Tracker, https://github.com/dbekaert/RAiDER/issues
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: LICENSE2.md
Dynamic: license-file

# RAiDER

Raytracing Atmospheric Delay Estimation for RADAR

[![Language](https://img.shields.io/badge/python-3.9%2B-blue.svg)](https://www.python.org/)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/dbekaert/RAiDER/blob/dev/LICENSE)
[![CircleCI](https://circleci.com/gh/dbekaert/RAiDER.svg?style=svg)](https://circleci.com/gh/dbekaert/RAiDER)
[![Coverage Status](https://coveralls.io/repos/github/dbekaert/RAiDER/badge.svg?branch=dev)](https://coveralls.io/github/dbekaert/RAiDER?branch=dev)

RAiDER-tools 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. 

Copyright (c) 2019-2022, 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.

## Contents

1. [Getting Started](#1-getting-started)
    - [Installing With Conda](#installing-with-conda)
    - [Using the Docker Image](#using-the-docker-image)
    - [Installing from Source](docs/Installing_from_source.md)
2. [Setup of third party weather model access](#2-setup-of-third-party-weather-model-access)
3. [Running RAiDER and Documentation](#3-running-raider-and-documentation)
4. [Citing](#4-citation)
5. [Development](#5-development)
    - [Contributors](#contributors) 
------

## 1. Getting Started

RAiDER has been tested on the following systems:
- Ubuntu v.16 and up
- Mac OS v.10 and up

RAiDER does **not** currently run on arm64 processors on Mac. We will update this note once the build becomes available. 

### Installing With Conda

RAiDER is available on [conda-forge](https://anaconda.org/conda-forge/raider). __[Conda](https://docs.conda.io/en/latest/index.html)__ is a cross-platform way to use Python that allows you to setup and use "virtual environments." These can help to keep dependencies for different sets of code separate. We recommend using [Miniforge](https://github.com/conda-forge/miniforge), a conda environment manager that uses conda-forge as its default code repo. Alternatively, see __[here](https://docs.anaconda.com/anaconda/install/)__ for help installing Anaconda and __[here](https://docs.conda.io/en/latest/miniconda.html)__ for installing Miniconda.

Installing RAiDER:
```
conda env create --name RAiDER  -c conda-forge raider
conda activate RAiDER
```

### Using the Docker image

RAiDER provides a [docker container image](https://docs.docker.com/get-started/) with all the necessary dependencies pre-installed. To get the latest released version: 
```sh
docker pull ghcr.io/dbekaert/raider:latest
```
a specific release version (>=v0.2.0 only):
```sh
docker pull ghcr.io/dbekaert/raider:0.2.0
```
or the current development version:
```sh
docker pull ghcr.io/dbekaert/raider:test
```

To run `raider.py` inside the container:
```sh
docker run -it --rm ghcr.io/dbekaert/raider:latest
```
To mount your current directory inside the container so that files will be written back to your local machine:
```sh
docker run -it -v ${PWD}:/home/raider/work --rm ghcr.io/dbekaert/raider:latest
cd work
```
To jump into a `bash` shell inside the container:
```sh
docker run -it --rm --entrypoint /bin/bash ghcr.io/dbekaert/raider:latest -l
```

For more docker run options, see: <https://docs.docker.com/engine/reference/run/>.


------
## 2. Setup of third party weather model access

RAiDER has the ability to download weather models from third-parties; some of which require license agreements. See [here](https://github.com/dbekaert/RAiDER/blob/dev/docs/WeatherModels.md) for details.

------
## 3. Running RAiDER and Documentation

For detailed documentation, examples, and Jupyter notebooks see the [RAiDER-docs repository](https://github.com/dbekaert/RAiDER-docs).
We welcome contributions of other examples on how to leverage the RAiDER (see [here](https://github.com/dbekaert/RAiDER/blob/dev/CONTRIBUTING.md) for instructions).  
``` raider.py -h ``` provides a help menu and set of example run configurations to get started.
The RAiDER scripts are highly modularized in Python and allows for building your own processing workflow.

------
## 4. Citation
TODO

------
## 5. Development

Contributions are welcome and heartily encourage! See our [contributing guide](https://github.com/dbekaert/RAiDER/blob/dev/CONTRIBUTING.md).

### Development install
For development, we recommend installing directly from source.  
Solving can take a long time (upwards of an hour), so we also recommend 
taking advantage of the included lockfile to install faster.
```sh
# Clone the project
git clone https://github.com/dbekaert/RAiDER.git
cd RAiDER

# Install conda-lock (if not already installed)
pip install condax
condax install conda-lock

# Create RAiDER environment using the lockfile
conda-lock install
# Or solve and create from scratch without lockfile:
# conda env create -f environment.yml

conda activate RAiDER

# Symlink project folder in as a pip package in the environment
python -m pip install -e .
```
For more details on installing from source see [here](https://github.com/dbekaert/RAiDER/blob/dev/docs/Installing_from_source.md).

------
### Contributors

* David Bekaert
* Jeremy Maurer
* Raymond Hogenson
* Brett Buzzanga
* Piyush Agram _(Descartes Labs)_
* Yang Lei
* Rohan Weeden
* Simran Sangha
* [_other community members_](https://github.com/dbekaert/RAiDER/graphs/contributors)

We welcome community contributions! For instructions see [here](https://github.com/dbekaert/RAiDER/blob/dev/CONTRIBUTING.md).
