Picongpu: When to Choose Calorimeter Name

[ax3l]

In the calorimeter plugin, the filter is encoded twice in the filename, e.g.:

In the calorimeter plugin, we don't yet doc how (and when) to chose a .file-name, e.g.:

simOutput/H_calorimeter/all/H_calorimeter_<file>_all_12000_0_0_0.h5

The order of arguments is also a bit off, we usually write:

<species>_<filter>_...

directly together. nope. as now is consistent.

seen in PIConGPU 0.4.1

[psychocoderHPC]

This is not a bug could it be that you named the output file --H_calorimeter.file "all"

The name of the file is created out of <species>_<pluginname>_<file>_<filter>_<timestep>_<mpiposition>.h5

<pluginname> is always calorimeter here.

[ax3l]

Ah yes, I was probably over-cautious in the file name!

so calling it calorimeter hm, something fixed; as .file for a ton of species and species filters is save I guess :)

I remember, we just expose the name in case one has

• same filter
• same species
• but different energy range / bins / observation angle.

Maybe we should doc this?

[psychocoderHPC]

We can add <species>_<pluginname>_<file>_<filter>_<timestep>_<mpiPosition>.h5 to https://picongpu.readthedocs.io/en/0.4.1/usage/plugins/particleCalorimeter.html#output but I would try to keep it short.
A drawback is that it is very fast outdated e.g. as soon as we change the output method to the OpenPMD-api.

[ax3l]

<pluginname> is fixed to calorimeter ;-)
and <mpiposition> is always 0_0_0 ;-)

We should adjust it to <species>_<filter>_calorimeter_<suffix>_<timestep>_0_0_0.h5 and can update it anytime when the output method should be changed in the future.

[ax3l]

Will provide two PRs, one docing the current dev and one updating the order.

[psychocoderHPC]

I know that we can update it any time but the potential to miss it is high.
Never the less you missed the filename in the description.

[psychocoderHPC]

Normally _calorimeter can be removed from the file name because we have it in the folder hierarchy but we discussed it in the passed and you said you like to keep it in the file name.

[ax3l]

I know that we can update it any time but the potential to miss it is high.

There is more to update for a plugin if we change it's I/O routines ;-) E.g. post-processing libraries. Currently, this plugin does not even write openPMD since openPMD 1.* can only describe spatial meshes.

[psychocoderHPC]

closed with #2800

[ax3l]

nope, I still want to change the order in dev for the filename.

[ax3l]

oh weird, we do suffix the filter in other plugins.
I must have mismatched this with the tool argument order.
In that case it's done :)