fix: add documentation

This commit is contained in:
2023-09-19 10:38:48 +02:00
parent d1cc075f89
commit 35ea790c19

View File

@@ -9,7 +9,8 @@ from bec_lib.core.file_utils import FileWriterMixin
class csaxs_archiver:
"""Class to archive data from a beamtime.
To run this script from a shell, go to discovery.psi.ch and copy your token.
Afterwards, get a Keberos token (kinit) for yourself in the shell that you run this code.
Afterwards, get a Keberos token (kinit) for yourself in the shell.
Activate the bec_venv by doing "source bec_venv/bin/activate" and then run this code via python $filename.
As a last step, adjust the dictionary below in if __name__ == '__main__' with your token as well as information about the experiment
"""