Binning Plugin TODOs and Roadmap

[ikbuibui]

TODOs for the flexible Binning plugin

• Profile the binning
• Add more axes
  • Log Axes
  • Generic Axes defined with edges
  • LogLinLog Axes
  • String Axes
• Reduce (MPI) the binning histogram buffer in place
• Bin a particle multiple times - Useful for RNG based functors, say to generate distributions
• Add ability to apply post processing functor on the histogram before doing a data dump
• Discuss sane defaults, default examples and pre-define functors for common quantities (Maybe as a PICMI extension?)
• Split the binning histogram across GPUs according to domain decomposition if position axes are defined.
  • Rather than holding the full binning on each GPU
  • This decomposition will imply that the bin size is smaller than the extent of the position simulated on a GPU
• Auto binning ranges and splitting - Automatically and dynamically in the simulation choose binning range min, max and number of bins
• Option to only bin particles which are leaving (Add ability to bin particles leaving the simulation #5039) (confusions about the particle Calorimeter plugin #4946 (comment))
• Restart and Checkpoint Support (Implement checkpoint and restart capability to the binning plugin #4766)
• Add ability to disable overflow bins (Make overflow bins optional in Binning plugin #4770)
• Particle Filtering - Bin/Don't bin particles matching certain criteria (Add per species particle filtering #5249)
• Bin fields (Add field binning to binning plugin #5265) (requested Time-accumulated Poynting flux through boundaries #4972)
• Add flexible accumulation methods (Flexible accumulation for binning #5289)

[psychocoderHPC]

@ikbuibui If I do not miss something then the binning plugin is missing the OpenMPD annotation if a value is including the weighting and how it scales with the weighting.
The only OpenPMD anotation the user can pass the openPMD unit description.

[ikbuibui]

As discussed in the office, the weighting is a particle property and not a property of bins, so the the weighting annotation for bins makes no sense. If the user needs special treatment of weighted quantities it can be done inside the functors.