<!--
SPDX-FileCopyrightText: 2022 German Aerospace Center (DLR)
SPDX-License-Identifier: MIT
-->
# gcodeReader
[](https://gitlab.dlr.de/fa_sw/peridynamik/gcodereader/-/commits/main)
[](https://gitlab.dlr.de/fa_sw/peridynamik/gcodereader/-/commits/main)
[](https://gitlab.dlr.de/fa_sw/peridynamik/gcodereader/-/blob/main/LICENSE)
Read gcode and translate into peridigm input
## 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/gcodereader)
- TODO: describe features
## Installation
### Installation from source
Get gcodereader source from
> https://gitlab.dlr.de/fa_sw/peridynamik/gcodereader.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/gcodereader/-/packages)
You can download the latest artifact (*.whl) and install it using
> cd gcodereader
> python setup.py install gcodereader<version>.whl
### Test the installation
In python execute:
> import gcodereader
### 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 gcodereader 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 _gcodereader_
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://gcodereader.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/gcodereader",
"name": "gcodereader",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "gcode,peridigm,translator",
"author": "Jan-Timo Hesse",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/c1/8c/930e87487837fcb21f11659ea7aff9d7aa91dcd83a7aa19c1fba43fdff0e/gcodereader-0.4.5.tar.gz",
"platform": null,
"description": "<!--\nSPDX-FileCopyrightText: 2022 German Aerospace Center (DLR)\n\nSPDX-License-Identifier: MIT\n-->\n# gcodeReader\n\n\n[](https://gitlab.dlr.de/fa_sw/peridynamik/gcodereader/-/commits/main)\n[](https://gitlab.dlr.de/fa_sw/peridynamik/gcodereader/-/commits/main)\n[](https://gitlab.dlr.de/fa_sw/peridynamik/gcodereader/-/blob/main/LICENSE)\n\n\nRead gcode and translate into peridigm input\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/gcodereader)\n\n- TODO: describe features\n\n\n## Installation\n\n### Installation from source\nGet gcodereader source from\n\n> https://gitlab.dlr.de/fa_sw/peridynamik/gcodereader.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/gcodereader/-/packages)\n\nYou can download the latest artifact (*.whl) and install it using\n\n\n> cd gcodereader\n> python setup.py install gcodereader<version>.whl\n\n\n### Test the installation\nIn python execute:\n\n> import gcodereader\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 gcodereader 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 _gcodereader_\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://gcodereader.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": "Read gcode and translate into peridigm input",
"version": "0.4.5",
"project_urls": {
"Homepage": "https://gitlab.dlr.de/fa_sw/peridynamik/gcodereader",
"Repository": "https://gitlab.dlr.de/fa_sw/peridynamik/gcodereader"
},
"split_keywords": [
"gcode",
"peridigm",
"translator"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1a2dfeea30df7d6847bff7ed332a2687e3fb758effe33a890fe08e43b0aea240",
"md5": "882d8932e407c116c30726eb55306d12",
"sha256": "12e1b77cf9cbe2a0058daff8f47ada7e8171002f5f28b7ef0e9f1a3ed0fdc994"
},
"downloads": -1,
"filename": "gcodereader-0.4.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "882d8932e407c116c30726eb55306d12",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 19024,
"upload_time": "2023-07-27T08:15:13",
"upload_time_iso_8601": "2023-07-27T08:15:13.022485Z",
"url": "https://files.pythonhosted.org/packages/1a/2d/feea30df7d6847bff7ed332a2687e3fb758effe33a890fe08e43b0aea240/gcodereader-0.4.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c18c930e87487837fcb21f11659ea7aff9d7aa91dcd83a7aa19c1fba43fdff0e",
"md5": "d79519a823dcc8c2783a1d26368b3f7d",
"sha256": "c99894966c04942f0230c9cc8478f2e28a5275542cff90104c0ebcf8e73b23b5"
},
"downloads": -1,
"filename": "gcodereader-0.4.5.tar.gz",
"has_sig": false,
"md5_digest": "d79519a823dcc8c2783a1d26368b3f7d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 18871,
"upload_time": "2023-07-27T08:15:14",
"upload_time_iso_8601": "2023-07-27T08:15:14.758952Z",
"url": "https://files.pythonhosted.org/packages/c1/8c/930e87487837fcb21f11659ea7aff9d7aa91dcd83a7aa19c1fba43fdff0e/gcodereader-0.4.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-27 08:15:14",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "gcodereader"
}
JSON