Skip to main content

Reader for exodus files

Project description

exodusReader

pipeline status coverage report 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

  • 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

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

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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

exodusreader-0.1.3.tar.gz (12.8 kB view details)

Uploaded Source

Built Distribution

exodusreader-0.1.3-py3-none-any.whl (11.5 kB view details)

Uploaded Python 3

File details

Details for the file exodusreader-0.1.3.tar.gz.

File metadata

  • Download URL: exodusreader-0.1.3.tar.gz
  • Upload date:
  • Size: 12.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for exodusreader-0.1.3.tar.gz
Algorithm Hash digest
SHA256 1d916fb6acfa42d61f4d700f2e351051b7dfd0a5548e2bc3434211a536fd9bab
MD5 218f7cea67c5b594e796a65f0336a6e1
BLAKE2b-256 c00aca0f5933934f6c3359761150cd4e6ff903bac95c314356fe53aabf704d50

See more details on using hashes here.

File details

Details for the file exodusreader-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: exodusreader-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 11.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for exodusreader-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 de975d0fc7723283be062a13eb14162f42c225698b44b0846703ecf4075e5954
MD5 7d099fa4c81dac8f3bcec312d67fb663
BLAKE2b-256 97519d4d9a7eb9d9fd63b378532999864feeac9fde57143d02f0c9a690959447

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page