| Name | pyiron-dataclasses JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | None |
| Summary | Dataclasses for the pyiron workflow framework |
| upload_time | 2024-10-03 18:21:45 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <3.13,>=3.9 |
| 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. |
| keywords |
pyiron
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Dataclasses for pyiron
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.v1.converter import get_dataclass
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`:
* `0.6.13`
* `0.6.12`
Raw data
{
"_id": null,
"home_page": null,
"name": "pyiron-dataclasses",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.9",
"maintainer_email": null,
"keywords": "pyiron",
"author": null,
"author_email": "Jan Janssen <janssen@mpie.de>",
"download_url": "https://files.pythonhosted.org/packages/78/7a/0a5de72c516117b0a721f6a7d0ade8709e5baecca3c9da3a576893e054a3/pyiron_dataclasses-0.0.1.tar.gz",
"platform": null,
"description": "# Dataclasses for pyiron\nThe `pyiron_dataclasses` module provides a series of [dataclasses](https://docs.python.org/3/library/dataclasses.html) \nfor the `pyiron` workflow framework. It can load HDF5 files created by `pyiron_atomistics` and read the content stored \nin those files, without depending on `pyiron_atomistics`. Furthermore, it is not fixed to a single version of \n`pyiron_atomistics` but rather matches multiple versions of `pyiron_atomistics` to the same API version of \n`pyiron_dataclasses`. \n\n## Usage \nUsing the `get_dataclass()` function of the built-in converter:\n```python\nfrom h5io_browser import read_dict_from_hdf\nfrom pyiron_dataclasses.v1.converter import get_dataclass\n\njob_classes = get_dataclass(\n job_dict=read_dict_from_hdf(\n file_name=job.project_hdf5.file_name,\n h5_path=\"/\",\n recursive=True,\n slash='ignore',\n )[job.job_name]\n)\njob_classes\n```\n\n## Supported Versions \n### Version 1 - `v1`\nSupported versions of `pyiron_atomistics`:\n* `0.6.13`\n* `0.6.12`\n",
"bugtrack_url": null,
"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. ",
"summary": "Dataclasses for the pyiron workflow framework",
"version": "0.0.1",
"project_urls": {
"Documentation": "https://github.com/pyiron/pyiron_dataclasses",
"Homepage": "https://github.com/pyiron/pyiron_dataclasses",
"Repository": "https://github.com/pyiron/pyiron_dataclasses"
},
"split_keywords": [
"pyiron"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b6f88b85bee1a84fe6d19697c2cd461444b468f9bc3923c1a6471301282749d0",
"md5": "411794d8c5446dcff49cc868f43372ed",
"sha256": "07af81fe503ab4d8e502cbd0951cff3f72a576a1bc710b6ce6f779ed9a544269"
},
"downloads": -1,
"filename": "pyiron_dataclasses-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "411794d8c5446dcff49cc868f43372ed",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 20998,
"upload_time": "2024-10-03T18:21:43",
"upload_time_iso_8601": "2024-10-03T18:21:43.740539Z",
"url": "https://files.pythonhosted.org/packages/b6/f8/8b85bee1a84fe6d19697c2cd461444b468f9bc3923c1a6471301282749d0/pyiron_dataclasses-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "787a0a5de72c516117b0a721f6a7d0ade8709e5baecca3c9da3a576893e054a3",
"md5": "1f4a526c1d9525646e45b1a9a2bcbc85",
"sha256": "23270dc5825b433da32d8716de49ca70514142b85fc1b2aaa93afd05bc4b7e91"
},
"downloads": -1,
"filename": "pyiron_dataclasses-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "1f4a526c1d9525646e45b1a9a2bcbc85",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 14365,
"upload_time": "2024-10-03T18:21:45",
"upload_time_iso_8601": "2024-10-03T18:21:45.005330Z",
"url": "https://files.pythonhosted.org/packages/78/7a/0a5de72c516117b0a721f6a7d0ade8709e5baecca3c9da3a576893e054a3/pyiron_dataclasses-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-03 18:21:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pyiron",
"github_project": "pyiron_dataclasses",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pyiron-dataclasses"
}
