<!--
SPDX-FileCopyrightText: 2022 German Aerospace Center (DLR)
SPDX-License-Identifier: MIT
-->
# exodusReader
[](https://gitlab.dlr.de/fa_sw/peridynamik/exodusreader/-/commits/main)
[](https://gitlab.dlr.de/fa_sw/peridynamik/exodusreader/-/commits/main)
[](https://gitlab.dlr.de/fa_sw/peridynamik/exodusreader/-/blob/main/LICENSE)
Reader for exodus files
## Todos to setup project
- in gitlab activate CI/CD (settings→general→visibility→CI/CD)
- create token for pypi (todo: more text)
- adapt coverage percentage
## Features
* Free software: BSD license
* [Documentation](https://fa_sw.pages.gitlab.dlr.de/peridynamik/exodusreader)
- TODO: describe features
## Installation
### Installation from source
Get exodusreader source from
> https://gitlab.dlr.de/fa_sw/peridynamik/exodusreader.git
and add the /src folder to pythonpath in the environment variables
### Installation as python package
Install it from [the gitlab packacke registry](https://gitlab.dlr.de/fa_sw/peridynamik/exodusreader/-/packages)
You can download the latest artifact (*.whl) and install it using
> cd exodusreader
> python setup.py install exodusreader<version>.whl
### Test the installation
In python execute:
> import exodusreader
### Developers
Developers may also install the pre-commit hook.
**Precommit**
1. install the pre-commit
> pip install pre-commit
or
> conda isntall pre-commit
2. In the exodusreader folder
> pre-commit install
This enables the pre-commit hooks defined in _.pre-commit-config.yaml_
and eases your commits and successful pipline runs.
## Usage
## Contributing to _exodusreader_
We welcome your contribution!
If you want to provide a code change, please:
* Create a fork of the GitLab project.
* Develop the feature/patch
* Provide a merge request.
> If it is the first time that you contribute, please add yourself to the list
> of contributors below.
## Citing
No citing required
## License
* Free software: BSD license
* Documentation: https://exodusreader.readthedocs.io.
## Change Log
see [changelog](changelog.md)
## CI Pipeline and Jobs for Developers
If you encounter any failed job on the pipeline you can run them locally for more information.
(prerequisite: have _make_ and _poetry_ installed [e.g. conda install make poetry])
See all availabe make targets used for the ci-jobs
> make list
Find the target with matching names and execute them locally e.g.:
> make test
If **check-formatting** fails, run the following to fix issues.
> make formatting
If **check-license-metadata** fails, run
> make check-license-metadata
identify the corresponding filename and run the following (include the filename in $filename)
> poetry run reuse addheader --copyright="German Aerospace Center (DLR)" --license="MIT" $filename
## Authors
[Jan-Timo Hesse](mailto:Jan-Timo.Hesse@dlr.de)
Raw data
{
"_id": null,
"home_page": "https://gitlab.dlr.de/fa_sw/peridynamik/exodusreader",
"name": "exodusreader",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "exodusReader",
"author": "Jan-Timo Hesse",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/c0/0a/ca0f5933934f6c3359761150cd4e6ff903bac95c314356fe53aabf704d50/exodusreader-0.1.3.tar.gz",
"platform": null,
"description": "<!--\nSPDX-FileCopyrightText: 2022 German Aerospace Center (DLR)\n\nSPDX-License-Identifier: MIT\n-->\n# exodusReader\n\n\n[](https://gitlab.dlr.de/fa_sw/peridynamik/exodusreader/-/commits/main)\n[](https://gitlab.dlr.de/fa_sw/peridynamik/exodusreader/-/commits/main)\n[](https://gitlab.dlr.de/fa_sw/peridynamik/exodusreader/-/blob/main/LICENSE)\n\n\nReader for exodus files\n\n## Todos to setup project\n- in gitlab activate CI/CD (settings\u2192general\u2192visibility\u2192CI/CD)\n- create token for pypi (todo: more text)\n- adapt coverage percentage\n\n## Features\n\n\n* Free software: BSD license\n\n\n* [Documentation](https://fa_sw.pages.gitlab.dlr.de/peridynamik/exodusreader)\n\n- TODO: describe features\n\n\n## Installation\n\n### Installation from source\nGet exodusreader source from\n\n> https://gitlab.dlr.de/fa_sw/peridynamik/exodusreader.git\n\nand add the /src folder to pythonpath in the environment variables\n\n### Installation as python package\nInstall it from [the gitlab packacke registry](https://gitlab.dlr.de/fa_sw/peridynamik/exodusreader/-/packages)\n\nYou can download the latest artifact (*.whl) and install it using\n\n\n> cd exodusreader\n> python setup.py install exodusreader<version>.whl\n\n\n### Test the installation\nIn python execute:\n\n> import exodusreader\n\n### Developers\n\nDevelopers may also install the pre-commit hook.\n\n**Precommit**\n1. install the pre-commit\n > pip install pre-commit\n or\n > conda isntall pre-commit\n2. In the exodusreader folder\n > pre-commit install\n\nThis enables the pre-commit hooks defined in _.pre-commit-config.yaml_\nand eases your commits and successful pipline runs.\n\n## Usage\n\n## Contributing to _exodusreader_\n\nWe welcome your contribution!\n\nIf you want to provide a code change, please:\n\n* Create a fork of the GitLab project.\n* Develop the feature/patch\n* Provide a merge request.\n\n> If it is the first time that you contribute, please add yourself to the list\n> of contributors below.\n\n\n## Citing\n\nNo citing required\n\n## License\n\n\n\n* Free software: BSD license\n* Documentation: https://exodusreader.readthedocs.io.\n\n\n\n\n\n## Change Log\n\nsee [changelog](changelog.md)\n\n## CI Pipeline and Jobs for Developers\n\nIf you encounter any failed job on the pipeline you can run them locally for more information.\n(prerequisite: have _make_ and _poetry_ installed [e.g. conda install make poetry])\n\nSee all availabe make targets used for the ci-jobs\n\n> make list\n\nFind the target with matching names and execute them locally e.g.:\n> make test\n\nIf **check-formatting** fails, run the following to fix issues.\n> make formatting\n\nIf **check-license-metadata** fails, run\n> make check-license-metadata\n\nidentify the corresponding filename and run the following (include the filename in $filename)\n> poetry run reuse addheader --copyright=\"German Aerospace Center (DLR)\" --license=\"MIT\" $filename\n\n## Authors\n\n[Jan-Timo Hesse](mailto:Jan-Timo.Hesse@dlr.de)\n\n",
"bugtrack_url": null,
"license": "BSD license",
"summary": "Reader for exodus files",
"version": "0.1.3",
"project_urls": {
"Homepage": "https://gitlab.dlr.de/fa_sw/peridynamik/exodusreader",
"Repository": "https://gitlab.dlr.de/fa_sw/peridynamik/exodusreader"
},
"split_keywords": [
"exodusreader"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "97519d4d9a7eb9d9fd63b378532999864feeac9fde57143d02f0c9a690959447",
"md5": "7d099fa4c81dac8f3bcec312d67fb663",
"sha256": "de975d0fc7723283be062a13eb14162f42c225698b44b0846703ecf4075e5954"
},
"downloads": -1,
"filename": "exodusreader-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7d099fa4c81dac8f3bcec312d67fb663",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 11461,
"upload_time": "2023-07-27T08:11:49",
"upload_time_iso_8601": "2023-07-27T08:11:49.295643Z",
"url": "https://files.pythonhosted.org/packages/97/51/9d4d9a7eb9d9fd63b378532999864feeac9fde57143d02f0c9a690959447/exodusreader-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c00aca0f5933934f6c3359761150cd4e6ff903bac95c314356fe53aabf704d50",
"md5": "218f7cea67c5b594e796a65f0336a6e1",
"sha256": "1d916fb6acfa42d61f4d700f2e351051b7dfd0a5548e2bc3434211a536fd9bab"
},
"downloads": -1,
"filename": "exodusreader-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "218f7cea67c5b594e796a65f0336a6e1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 12791,
"upload_time": "2023-07-27T08:11:50",
"upload_time_iso_8601": "2023-07-27T08:11:50.487251Z",
"url": "https://files.pythonhosted.org/packages/c0/0a/ca0f5933934f6c3359761150cd4e6ff903bac95c314356fe53aabf704d50/exodusreader-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-27 08:11:50",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "exodusreader"
}
JSON