Descriptors for input and output of TurTLE
I think it would be very helpful for new users to label all of the input and output of TurTLE.
For the parameters, looking at turtle DNS NSVEparticles --help
, for example, still shows a number of parameters (both basic and particle-related) that have no description.
For the output, one would usually use the DNS class. So far, only the descriptors of compute_statistics and compute_time_averages or the code itself can be used to figure out what the contents of dnsobject.statistics mean. Could we add a page in the documentation (or does it exist?) that gives description and formula of the various quantities? Furthermore, there are quantities that TurTLE computes by default but that are not read by the DNS class (histograms, moments). Could they be added to the DNS class reader? Alternatively, one could also describe how they are saved in the TurTLE HDF5 files.