Tutorial

I would suggest to move Tutorial section after installation.

Not sure about this. Ideally the user will read through the general documentation first to get an idea what is possible and then follow the tutorial with step by step instructions.

In my opinion, if you cover installation in the tutorial it should go first, otherwise after installation.

Installation and also the following sections about configuration and work flow cover in principle in more general way what is repeated in the tutorial step by step and in more detail and for a specific usecase, e.g. forcing for example the installation of karabo. The installation section does link to the tutorial at the end. If I am new to the project, I would probably first browse through the original general documentation to get an overview of what the package is about and then after that go through the tutorial and follow that to learn about the technical aspects.

Quite a few people just jump right in though. I have no strong opinion. Let’s see if @samartse has a tie breaking opinion, if not, we leave as is.

I have looked at the tutorial on the day of MR and have no comments relating details. Very clear introductory tutorial.

If the tutorial is self consistent and complete, which it hopefully is there is no problem with just jumping directly to the tutorial.

More introductory words may clarify what is all about. Let's assume that users knows python and learn Jupyter notebook with this tutorial. I would emphasize it here: show a line, how to run Jupyter notebook; remind to setup karabo environment (or make a check which python).

I would say, what offline calibration tool will do with this notebook. Basically it allows to run this notebook as a job (or many jobs) on Maxwell cluster or to run it as a script from command line.

Here (of somewhere early) I would give a link to explanation, what is Maxwell cluster (https://confluence.desy.de/display/IS/Running+Jobs+on+Maxwell).

Also I would give a command line to run this notebook (would it work out of the box from Jupyter-notebook? Seems not, at least for me.).

Add possible trouble-shooting. If output folder is not changes, proper output will be not produced. Some information about batch job is in temp/slurm_tmp_...../slurm-...out (including useful error messages).

added 34 commits

• 47b1ff9e...4db2ca0a - 31 commits from branch master
• 43d2f5bb - before megre of master
• d185b089 - resolved merge conflict
• c8a40c96 - comments from Mikhail

Compare with previous version

added 34 commits

• 47b1ff9e...4db2ca0a - 31 commits from branch master
• 43d2f5bb - before megre of master
• d185b089 - resolved merge conflict
• c8a40c96 - comments from Mikhail

Compare with previous version

added 34 commits

• 47b1ff9e...4db2ca0a - 31 commits from branch master
• 43d2f5bb - before megre of master
• d185b089 - resolved merge conflict
• c8a40c96 - comments from Mikhail

Compare with previous version

added 34 commits

• 47b1ff9e...4db2ca0a - 31 commits from branch master
• 43d2f5bb - before megre of master
• d185b089 - resolved merge conflict
• c8a40c96 - comments from Mikhail

Compare with previous version

added 1 commit

• 37123a4a - put in concurrency

Compare with previous version

merged

mentioned in commit 51ce9271