Metadata-Version: 2.4
Name: pyarch5
Version: 1.1.0
Summary: Read and analyze HDF5 files with 'ArcH5' schema
Author-email: Aitor Diaz-Andres <ad.andres@outlook.com>
License: MIT
Project-URL: Homepage, https://gitlab.com/sanerdor/pyarch5
Project-URL: Repository, https://gitlab.com/sanerdor/pyarch5
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: h5py>=3.15.1
Requires-Dist: numpy>=2.4.0
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"
Dynamic: license-file

# pyarch5

Python library to read and analyze HDF5 files following the
**[ArcH5](https://gitlab.com/sanerdor/arch5)** schema.

## Installation

```bash
pip install pyarch5
```

## Documentation

Full documentation, including the complete API reference, is available at [pyarch5.readthedocs.io](https://pyarch5.readthedocs.io).


## Requirements

- Python >= 3.12
- h5py >= 3.15.1
- numpy >= 2.4.0


## License

MIT


# pyarch5

Read and analyze HDF5 files with the **ArcH5** schema.

[![PyPI version](https://img.shields.io/pypi/v/pyarch5.svg)](https://pypi.org/project/pyarch5/)
[![Python versions](https://img.shields.io/pypi/pyversions/pyarch5.svg)](https://pypi.org/project/pyarch5/)
[![Documentation Status](https://readthedocs.org/projects/pyarch5/badge/?version=latest)](https://pyarch5.readthedocs.io/en/latest/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Overview

[ArcH5](https://gitlab.com/sanerdor/arch5) is a schema for organizing
hierarchical project data within HDF5 files. `pyarch5` is the Python library for
reading, validating, and navigating files that follow this schema — it does not
define the schema itself.

## Installation

```bash
pip install pyarch5
```

Requires Python >= 3.12. See the [installation guide](https://pyarch5.readthedocs.io/en/latest/installation.html)
for virtual environment setup and installing from source.

## Documentation

Full documentation — including the user guide and complete API reference — is
available at
**[pyarch5.readthedocs.io](https://pyarch5.readthedocs.io/en/latest/)**.

For details on the ArcH5 schema itself, see the
[ArcH5 repository](https://gitlab.com/sanerdor/arch5).

## Requirements

- Python >= 3.12
- [h5py](https://docs.h5py.org/) >= 3.15.1
- [numpy](https://numpy.org/) >= 2.4.0

## Changelog

See [CHANGELOG.md](CHANGELOG.md) for a history of changes between
releases.

## License

Distributed under the MIT License. See [LICENSE](LICENSE) for details.
