Frequently Asked Questions

Is there a command line interface?

Yes, indeed. Some basic analysis can be used directly from the command line. Please check out the short tutorial CLI.

Is there a shell completion

Using the bash, zsh or fish shell click provides an easy way to provide shell completion, checkout the docs. In the case of bash you need to add following line to your ~/.bashrc

eval "$(_DCTMD_COMPLETE=bash_source dcTMD)"

In general one can call the module directly by its entry point $ dcTMD or by calling the module $ python -m dcTMD. For enabling the shell completion, the entry point needs to be used.

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.