Metadata-Version: 2.5
Name: aresys_io
Version: 1.0.0
Summary: Python library for reading and writing Aresys EO/SAR product formats.
Project-URL: Homepage, https://github.com/aresys-srl/aresys_io
Project-URL: Repository, https://github.com/aresys-srl/aresys_io
Project-URL: Documentation, https://opensource.aresys.it/aresys_io
Author-email: "Aresys S.R.L." <info@aresys.it>
License: MIT License
        
        Copyright (C) Aresys S.r.l. <info@aresys.it>
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE.txt
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Python: >=3.11
Requires-Dist: lxml
Requires-Dist: numpy>2
Requires-Dist: numpydantic
Requires-Dist: perseo-core
Requires-Dist: pydantic
Requires-Dist: scipy
Requires-Dist: xsdata>=26.2
Provides-Extra: dev
Requires-Dist: ruff>=0.16.7; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocstrings-python; extra == 'docs'
Requires-Dist: zensical; extra == 'docs'
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Provides-Extra: typecheck
Requires-Dist: pyrefly==1.1.0; extra == 'typecheck'
Requires-Dist: scipy-stubs; extra == 'typecheck'
Description-Content-Type: text/markdown

# Aresys Formats Input/Output (aresys_io)

![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)
[![Python 3.11+](https://img.shields.io/badge/python-3.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-blue)](https://python.org)
[![PyPI - Version](https://img.shields.io/pypi/v/aresys_io)](https://pypi.org/project/aresys_io/)
[![aresys-io CI](https://github.com/aresys-srl/aresys_io/actions/workflows/aresys_io.yml/badge.svg)](https://github.com/aresys-srl/aresys_io/actions/workflows/aresys_io.yml)

**Aresys I/O (`aresys_io`)** is the official Aresys Python library for reading, writing, and manipulating Aresys Earth Observation (EO) and Synthetic Aperture Radar (SAR) product formats.

Designed to be modular, independent, and extensible, `aresys_io` provides unified data access and metadata management across the entire SAR processing and simulation pipeline. It is built to integrate with [**PERSEO**](https://github.com/aresys-srl/perseo) ([docs](https://opensource.aresys.it/perseo)), the Aresys modular framework for Earth Observation and SAR data handling.

## Supported Formats & Core Features

`aresys_io` provides complete support for the core internal Aresys formats:

- **Product Folder (PF)**: The official Aresys SAR product format for organizing and storing data and auxiliary information. Supports **Level 0 (RAW)**, **Level 1 (SLC / GRD)**, and **Interferometric** products across multi-swath and multi-polarization channels with dedicated XML annotations, binary/TIFF raster data, manifests, and preview overlays.
- **Point Target Binary**: Dedicated format for discrete radar reflectors (such as corner reflectors, active radar calibrators, or synthetic point scatterers) used in SAR simulation, calibration, and IRF analysis. Stores 3D Cartesian coordinates ($X, Y, Z$) and full polarimetric radar cross sections ($HH, HV, VH, VV$) with support for memory-mapped zero-copy access and high-level `NominalPointTarget` representations.
- **SAR System**: Serialization and handling of SAR system and simulation parameters, including trajectory state vectors, timeline tables, swath parameter tables, and satellite definitions.
- **Metadata & Raster Engine**: Robust XML serialization/deserialization for Aresys metadata schemas, orbit and attitude modeling, polynomial conversions, and flexible 2D raster I/O.

## Installation

This package is available on [PyPI](https://pypi.org/project/aresys_io/) and can be installed with `pip`:

```bash
pip install aresys-io
```

> [!NOTE]
> `aresys_io` requires **Python 3.11** or higher.

## Documentation

- **Aresys I/O documentation**: [https://opensource.aresys.it/aresys_io](https://opensource.aresys.it/aresys_io)
- **PERSEO documentation**: [https://opensource.aresys.it/perseo](https://opensource.aresys.it/perseo)

## Related Repositories

| Repository | Description | Documentation |
| :--- | :--- | :--- |
| [aresys-srl/perseo](https://github.com/aresys-srl/perseo) | Python Ecosystem for Remote Sensing & Earth Observation | [docs](https://opensource.aresys.it/perseo/) |
| [aresys-srl/sct](https://github.com/aresys-srl/sct) | SAR Calibration Toolbox | [docs](https://opensource.aresys.it/sct/) |
| [aresys-srl/sct_plugins](https://github.com/aresys-srl/sct_plugins) | SCT input product format plugins | [docs](https://opensource.aresys.it/sct_plugins/) |

## Contributing

Contributions are welcome! If you encounter a bug, have a feature request, or want to contribute code:

- **Report bugs & request features**: open an issue on [GitHub](https://github.com/aresys-srl/aresys_io/issues). Include a clear description, steps to reproduce, and environment details.
- **Submit changes**: fork the repository, create a feature branch, and open a pull request. Ensure your code passes all linting (`ruff`), typing (`pyrefly`), and test suites (`pytest`).
- **Questions**: use GitHub Discussions for general questions and discussions.

## License

This project is licensed under the MIT License.

Copyright &copy; 2026-present Aresys S.r.l. <info@aresys.it>
