Metadata-Version: 2.1
Name: sarkit
Version: 0.1.0
Summary: Suite of SAR-related tools in Python.
Author: National Geospatial-Intelligence Agency
License: MIT
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Scientific/Engineering
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Project-URL: Documentation, https://sarkit.readthedocs.io/
Project-URL: Repository, https://github.com/ValkyrieSystems/sarkit.git
Project-URL: Bug Tracker, https://github.com/ValkyrieSystems/sarkit/issues
Requires-Python: >=3.11
Requires-Dist: lxml>=5.1.0
Requires-Dist: numpy>=1.26.3
Provides-Extra: verification
Requires-Dist: shapely>=2.0.2; extra == "verification"
Provides-Extra: processing
Requires-Dist: numba>=0.59.1; extra == "processing"
Provides-Extra: all
Requires-Dist: sarkit[processing,verification]; extra == "all"
Provides-Extra: dev-lint
Requires-Dist: ruff>=0.3.0; extra == "dev-lint"
Requires-Dist: mypy>=1.8.0; extra == "dev-lint"
Provides-Extra: dev-test
Requires-Dist: pytest>=7.4.4; extra == "dev-test"
Provides-Extra: dev
Requires-Dist: sarkit[dev-lint,dev-test]; extra == "dev"
Description-Content-Type: text/markdown

<div align="center">

<img src="https://raw.githubusercontent.com/ValkyrieSystems/sarkit/main/docs/source/_static/sarkit_logo.png" width=200>

[![Tests](https://github.com/ValkyrieSystems/sarkit/actions/workflows/tests.yml/badge.svg)](https://github.com/ValkyrieSystems/sarkit/actions/workflows/tests.yml)
[![Documentation Status](https://readthedocs.org/projects/sarkit/badge/?version=latest)](https://sarkit.readthedocs.io/en/latest/?badge=latest)

</div>

**SARkit** is a suite of Synthetic Aperture Radar (SAR)-related tools in Python developed and maintained by the National Geospatial-Intelligence Agency (NGA) to encourage the use of SAR data standards.

With SARkit, you can:

* read and write SAR standards files (CPHD, SICD, SIDD)
* interact with SAR XML metadata using more convenient Python objects
* check SAR data/metadata files for inconsistencies

## Origins
This project was developed at the National Geospatial-Intelligence Agency (NGA) as the modern successor to
[SarPy](https://github.com/ngageoint/sarpy).

## License
The software use, modification, and distribution rights are stipulated within the MIT license
(See [`LICENSE`](LICENSE) file).

## Contributing and Development
Contributions are welcome; for details see the [contributing guide](./CONTRIBUTING.md).

A few tips for getting started using [PDM](https://pdm-project.org/en/latest/) are below:


```shell
$ pdm install -G:all  # install SARkit with optional & dev dependencies
$ pdm run nox  # run lint and tests
$ pdm run nox -s docs  # build documentation
```
