Metadata-Version: 2.4
Name: sarxarray
Version: 1.4.0
Summary: Xarray extension for Synthetic Aperture Radar (SAR) data
Author: Fakhereh Sarah Alidoost, Simon van Diepen, Pranav Chandramouli, Francesco Nattino, Freek van Leijen
Author-email: Ou Ku <o.ku@esciencecenter.nl>
License-Expression: Apache-2.0
Project-URL: repository, https://github.com/TUDelftGeodesy/sarxarray
Project-URL: doi, https://doi.org/10.5281/zenodo.7717112
Project-URL: documentation, https://tudelftgeodesy.github.io/sarxarray/
Project-URL: changelog, https://tudelftgeodesy.github.io/sarxarray/CHANGELOG/
Keywords: radar,sar,insar,earth observation,distributed computing
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: dask[complete]
Requires-Dist: xarray
Requires-Dist: numpy
Requires-Dist: distributed
Requires-Dist: zarr
Requires-Dist: shapely
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pycodestyle; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Provides-Extra: docs
Requires-Dist: mkdocs; extra == "docs"
Requires-Dist: mkdocs-material; extra == "docs"
Requires-Dist: mkdocs-jupyter; extra == "docs"
Requires-Dist: mkdocstrings[python]; extra == "docs"
Requires-Dist: mkdocs-gen-files; extra == "docs"
Provides-Extra: demo
Requires-Dist: jupyterlab; extra == "demo"
Requires-Dist: matplotlib; extra == "demo"
Dynamic: license-file

# SARXarray

[![DOI](https://img.shields.io/badge/DOI-10.5281%2Fzenodo.7717027-blue.svg)](https://doi.org/10.5281/zenodo.7717027)
[![PyPI](https://img.shields.io/pypi/v/sarxarray.svg?colorB=blue)](https://pypi.python.org/project/sarxarray/)
[![JOSS](https://joss.theoj.org/papers/10.21105/joss.10492/status.svg)](https://doi.org/10.21105/joss.10492)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=TUDelftGeodesy_sarxarray&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=TUDelftGeodesy_sarxarray)
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/7980/badge)](https://www.bestpractices.dev/projects/7980)
[![Build](https://github.com/TUDelftGeodesy/sarxarray/actions/workflows/build.yml/badge.svg)](https://github.com/TUDelftGeodesy/sarxarray/actions/workflows/build.yml)
[![License](https://img.shields.io/github/license/TUDelftGeodesy/sarxarray)](https://opensource.org/licenses/Apache-2.0)


SARXarray is an open-source Xarray extension for Synthetic Aperture Radar (SAR) data. It is especially designed to work with large volume complex data, e.g. Single Look Complex (SLC) data, as well as derived products such as interferogram stacks. 


## Installation

SARXarray can be installed from PyPI:

```sh
pip install 'sarxarray'
```

or from the source:

```sh
git clone git@github.com:TUDelftGeodesy/sarxarray.git
cd sarxarray
pip install .
```

Note that Python version `>=3.10` is required for SARXarray.

### Install extra dependencies

SARXarray has some optional dependencies to support additional functionality besides the core features. You can install them depending on your needs:

```sh
pip install 'sarxarray[demo]'    # to run the demo notebook
pip install 'sarxarray[dev]'     # to run the test suite and enable code quality checks for developers
pip install 'sarxarray[docs]'    # to build the docs locally
```

## Documentation

For more information on usage and examples of SARXarray, please refer to the [documentation](https://tudelftgeodesy.github.io/sarxarray/).

## License

This software is licensed under the Apache License 2.0. See the LICENSE file for full text and copyright details.

Co-developed by Netherlands eScience Center and Delft University of Technology.
