gcodereader 0.4.5

Read gcode and translate into peridigm input

gcodeReader

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

• 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

You can download the latest artifact (*.whl) and install it using

cd gcodereader python setup.py install gcodereader.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

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