First complete idea of parameter and workflow / method description

💡 Please look only at those setting/validation methods which are listed in the Photon_conversion.yml file (all others need revision).

💡 Please look directly at the files (and don't do the classical merge request review and compare it to the main branch.

---

This is a first almost complete idea of how the parameter and workflow descriptions should look like.

As discussed several times this should include (if possible) all information about parameters and workflows and can be used:

• as main source of model parameter description (we need to agree on that; could also write this dynamically from the sim_telarray description; both ways would work)
• by gammasim-tools to e.g., determine that parameters forwarded to SimPipe have the correct values, format, etc.
• by gammasim-tools to determine which validation and setting workflows are applied
• to write Level C requirements (from setting and validation descriptions) and generally for documentation
• to get an overview of which applications are required on gammasim-tools

Goals of this review

• general feedback
• is the parameter description complete?
• which workflow/methods are needed for setting and validation of each simulation parameter?
• what is needed for a complete workflow/method description?

Parameter descriptions include:

• short and long description of the parameter (long description should be equivalent to the sim_telarray manual; although we might have done some minor text changes)
• instrument:class and instrument:type for applicability of each parameter
• data describes parameter format, type, units. This will be used to test parameters before writing them into the model parameter database. Includes also tables with a description of the axis characteristics.
• activity describes the setting and validation workflows to be applied
• source describes where the parameter comes from (not sure if this is really needed)
• simulation_software is at this point always sim_telarray or corsika. Will get extended if we e.g., add any additional values needed by ROBAST for the shadowing simulations

Setting and Validation workflow/methods description:

• division into workflows and methods: each workflow consist of several methods. Need to discuss if this is really necessary or if it is enough to list the methods directly in the parameter descriptions for setting/validation (at this point the workflows are simply a placeholder/short cut for several methods)
• should include a more detailed description of input/output (not yet done)
• methods corresponds to applications in gammasim-tools

💡 Please look only at those setting/validation methods which are listed in the Photon_conversion.yml file (all others need revision).

Files to look at (all in branch called parameter-workflow-updates):

• Photon_conversion.yml
• SettingWorkflows.yml
• ValidationWorkflows.yml
• Level C requirements (extracted from Setting and ValidationWorkflows; an example how we can use this description to write documentation)

None of the other files are in a state to be reviewed! Let's first discuss this example before putting time into all other parameters/workflows.

Issues / Questions

• fields with default values (default) not filled consistently in parameter descriptions
• any floating point parameter is assigned to be double. sim_telarray uses almost always doubles, so this is correct?
• not clear how to deal cases where the meaning of a parameter element depends on another element (e.g. for pm_transit_time, the meaning of the 4th values depends on the 3rd)
• documentation uses sometimes the expressions nominal/average voltage, sometimes average (e.g., pm_transit_time). Not clear if this is intended.