Artemis is experimental software, under active development – use at your own risk.
To run the tests, use:
pre-commit to run linters and format the code.
pre-commit is executed on CI to verify that the code is formatted properly.
To run it locally, use:
pre-commit run --all-files
pre-commit so that it runs before each commit, use:
Building the docs
To build the documentation, use:
python3 -m venv venv
pip install -r requirements.txt
How do I write my own module?
Please refer to the documentation.
Contributions are welcome! We will appreciate both ideas for new Artemis modules (added as GitHub issues) as well as pull requests with new modules or code improvements.
However obvious it may seem we kindly remind you that by contributing to Artemis you agree that the BSD 3-Clause License shall apply to your input automatically, without the need for any additional declarations to be made.