Metadata-Version: 2.4
Name: pyiron_dataclasses
Version: 0.0.3
Summary: Dataclasses for the pyiron workflow framework
Project-URL: Homepage, https://github.com/pyiron/pyiron_dataclasses
Project-URL: Documentation, https://github.com/pyiron/pyiron_dataclasses
Project-URL: Repository, https://github.com/pyiron/pyiron_dataclasses
Author-email: Jan Janssen <janssen@mpie.de>
License: BSD 3-Clause License
        
        Copyright (c) 2024, Jan Janssen
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        * Redistributions of source code must retain the above copyright notice, this
          list of conditions and the following disclaimer.
        
        * Redistributions in binary form must reproduce the above copyright notice,
          this list of conditions and the following disclaimer in the documentation
          and/or other materials provided with the distribution.
        
        * Neither the name of the copyright holder nor the names of its
          contributors may be used to endorse or promote products derived from
          this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License-File: LICENSE
Keywords: pyiron
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: <3.14,>=3.9
Requires-Dist: numpy<=2.3.2,>=1.23.5
Provides-Extra: convert
Requires-Dist: h5io-browser<=0.2.1,>=0.1.2; extra == 'convert'
Requires-Dist: pint<=0.25,>=0.18; extra == 'convert'
Description-Content-Type: text/markdown

# Dataclasses for pyiron
[![Pipeline](https://github.com/pyiron/pyiron_dataclasses/actions/workflows/pipeline.yml/badge.svg)](https://github.com/pyiron/pyiron_dataclasses/actions/workflows/pipeline.yml)
[![codecov](https://codecov.io/gh/pyiron/pyiron_dataclasses/graph/badge.svg?token=83H0OO0AFC)](https://codecov.io/gh/pyiron/pyiron_dataclasses)

The `pyiron_dataclasses` module provides a series of [dataclasses](https://docs.python.org/3/library/dataclasses.html) 
for the `pyiron` workflow framework. It can load HDF5 files created by `pyiron_atomistics` and read the content stored 
in those files, without depending on `pyiron_atomistics`. Furthermore, it is not fixed to a single version of 
`pyiron_atomistics` but rather matches multiple versions of `pyiron_atomistics` to the same API version of 
`pyiron_dataclasses`. 

## Usage 
Using the `get_dataclass()` function of the built-in converter:
```python
from h5io_browser import read_dict_from_hdf
from pyiron_dataclasses import get_dataclass_v1

job_classes = get_dataclass(
    job_dict=read_dict_from_hdf(
        file_name=job.project_hdf5.file_name,
        h5_path="/",
        recursive=True,
        slash='ignore',
    )[job.job_name]
)
job_classes
```

## Supported Versions 
### Version 1 - `v1`
Supported versions of `pyiron_atomistics`:

`pyiron_atomistics` version `0.6.X`:
* `0.6.20` - Jan 8 2025
* `0.6.21` - Jan 9 2025
* `0.6.22` - Jan 13 2025
* `0.6.23` - Feb 6 2025
* `0.6.24` - Feb 17 2025
* `0.6.25` - Feb 21 2025

`pyiron_atomistics` version `0.7.X`:
* `0.7.0` - Feb 28 2025
* `0.7.1` - Mar 5 2025
* `0.7.2` - Mar 12 2025
* `0.7.3` - Apr 3 2025
* `0.7.4` - Apr 14 2025
* `0.7.5` - Apr 17 2025
* `0.7.6` - Apr 30 2025
* `0.7.7` - May 17 2025
* `0.7.8` - Jun 6 2025
* `0.7.9` - Jul 6 2025
* `0.7.10` - Jul 6 2025
* `0.7.11` - Jul 10 2025
* `0.7.12` - Jul 21 2025
* `0.7.13` - Jul 22 2025
* `0.7.14` - Aug 13 2025
* `0.7.15` - Aug 18 2025
* `0.7.16` - Aug 26 2025
* `0.7.17` - Sep 9 2025
* `0.7.18` - Sep 15 2025