Closed glennra closed 8 months ago
Also it would be helpful to provide a link to the mentioned template module repository.
Thanks for the feedback. I updated the getting_started. Can you give some feedback if it's clearer now?
Yes it is much clearer now. Thank you. There is still this bug though: https://github.com/Ulm-IQO/qudi-core/blob/49d590caa65c92424dbca4caf97f9d528e6c391a/docs/getting_started.md?plain=1#L44C12-L44C12 says to load 'default.cfg' as mentioned in the installation guide but I couldn't find it mentioned in https://github.com/Ulm-IQO/qudi-core/blob/main/docs/setup/installation.md
The reason for this is that default.cfg is part of qudi-iqo-modules now and the referenced installation guide is the one from qudi-iqo-modules. Do you have a suggestion on how to make this point even clearer?
Just to make this perfectly clear:
qudi-core
does not contain any measurement toolchains. It just provides the framework as well as some useful tooling and libraries to develop addon packages. One such package (aimed at colorcenter research) is qudi-iqo-modules
.
So if you want to start any GUIs or dummy measurements, the corresponding example configuration is always provided by the respective repository where these toolchains are coming from. In the case of qudi-iqo-modules
this would be default.cfg
located at <repository_root>/src/qudi/default.cfg
.
The idea behind this separation is, that you do not have to install Gigabytes of useless toolchains and Python packages if you just want to implement your own measurement library. It simplifies package management tremendously.
The reason for this is that default.cfg is part of qudi-iqo-modules now and the referenced installation guide is the one from qudi-iqo-modules. Do you have a suggestion on how to make this point even clearer?
Maybe a link like the one in this comment would suffice and/or mention explicitly that the installation guide being referred to is the one for qudi-iqo-modules.
The reason for my confusion is that a document called "installation guide" is named here https://github.com/Ulm-IQO/qudi-core/blob/a4db9b0e6f637ac6963d67e31afd813563ab1a5c/docs/getting_started.md?plain=1#L23 but that is apparently not the installation guide referred to here https://github.com/Ulm-IQO/qudi-core/blob/a4db9b0e6f637ac6963d67e31afd813563ab1a5c/docs/getting_started.md?plain=1#L48
I clearified this part in the docs again. Any help on our documentation is always highly appreciated. So please feel free to post again with suggestions to improve.
Closed as no more issues with getting_started.md were reported.
https://github.com/Ulm-IQO/qudi-core/blob/eb2d4861141a6c72db894d91d07993f7ac9ec6a0/docs/getting_started.md?plain=1#L66C46-L66C46
This link is broken