Closed johannjacobsohn closed 5 years ago
The naming convention lies in the history/ organic growth of pyplis. The example scripts (ex01
-ex12
) were written first to serve as a guideline for a full analysis of SO2 camera images. They refer to each other and build up.
Later, single functionalities should be clarified without necessary being important for a typical workflow e.g. definition of a camera. These scripts were first called ex0
but then separated into ex0_1
- ex0_7
.
That is where the naming convention comes from. But I totally agree that they could be renamed or clustered differently to make it more intuitive.
maybe example%i and intro%i would be somewhat more intuitive?
Thanks for your thoughts on this! I agree that the names could be clearer (as in other parts of the pyplis API, cf. #20), but I would like to keep the names of the scripts as they are, since they are referred to in the paper (see Table A2. therein).
On the longer term, I would like to move away from this set of example scripts and have new and better examples / tutorials in the form of jupyter notebooks (potentially online in combination with a JupyterHub server to run them in a virtual env from anywhere).
I close this issue now and will open a new one that will pick up the tutorial notebook idea.
I dont understand the difference between an example and an intro script, neighter in content nor in file name.
I can guess from the runner scripts that
ex0_
are intro scripts andex[<0]_
are example scripts, but maybe this distinction could me made clearer.RUN_EXAMPLE_SCRIPTS.py
RUN_INTRO_SCRIPTS.py
In any case, what is the exact distinction between an example scripts and an intro script?