Reader for exodus files
Project description
exodusReader
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
- TODO: describe features
Installation
Installation from source
Get exodusreader source from
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
- install the pre-commit
pip install pre-commit or conda isntall pre-commit
- 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
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for exodusreader-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | de975d0fc7723283be062a13eb14162f42c225698b44b0846703ecf4075e5954 |
|
MD5 | 7d099fa4c81dac8f3bcec312d67fb663 |
|
BLAKE2b-256 | 97519d4d9a7eb9d9fd63b378532999864feeac9fde57143d02f0c9a690959447 |