Frequently Asked Questions

Should I upgrade the package?

You can check out the CHANGELOG.md to see what changed.

How can I interpret the results?

Check out our publication for two detailed examples.

Is it possible to install the CLI only?

Partially, yes. If you do not want to screw up your current Python environment there are multiples possibilities. Either create a virtual environment on your own via conda or venv, or you can simply use pipx.

Feature X is missing

If you believe that a crucial functionality/method is missing, feel free to open an issue and describe the missing functionality and why it should be added. Alternatively, you can implement it yourself and create a PR to add it to this package, see contributing guide.

I found a bug. What to do next?

If you find a bug in this package, it is very kind of you to open an issue/bug report. This allows us to identify and fix the problem, thus improving the overall quality of the software for all users. By providing a clear and concise description of the problem, including steps to reproduce it, and relevant information such as device, operating system, and software version, you will help us resolve the problem quickly and effectively. Submitting a bug report is a valuable contribution to the software and its community, and is greatly appreciated by the development team.