bas-rustenburg/pyzacros

Python library to handle KMC codes.

fair-software.nl recommendations	Badges
1. Code repository
2. License
3. Community Registry
4. Enable Citation
5. Checklist
Other best practices
Continuous integration

(Customize these badges with your own links, and check https://shields.io/ or https://badgen.net/ to see which other badges are available.)

pyZacros

A Python library to handle KMC codes.

The project setup is documented in a separate document. Feel free to remove this document (and/or the link to this document) if you don't need it.

Installation

To install pyZacros, do:

git clone https://github.com/NLeSC/pyZacros.git
cd pyZacros
pip install .

Run tests (including coverage) with:

python setup.py test

Documentation

Include a link to your project's full documentation here.

Contributing

If you want to contribute to the development of pyZacros, have a look at the contribution guidelines.

License

pyZacros is an Open Source project supported by the Netherlands eScience Center (NLeSC) and Software for Chemistry & Materials BV (SCM, and previously known as Scientific Computing & Modelling NV). The terms of the [LGPL-3.0 license]* apply. As an exception to the LGPL-3.0 license, you agree to grant SCM a [BSD 3-Clause license]** to the contributions you commit on this Github or provide to SCM in another manner.

* https://opensource.org/licenses/LGPL-3.0

** https://opensource.org/licenses/BSD-3-Clause

[LGPL-3.0 license]: https://opensource.org/licenses/LGPL-3.0 "LGPL-3.0 license" [BSD 3-Clause license]: https://opensource.org/licenses/BSD-3-Clause "BSD 3-Clause license"

Credits

This package was created with Cookiecutter and the NLeSC/python-template.