The Active Matter Evaluation Package (AMEP) - a Python library for the analysis of particle-based and continuum simulation data of soft and active matter systems
The documentation of the VelDist evaluation class is missing the description of several keyword arguments, namely vmin, vmax, v2max. The description how the limits of the distribution for v² and |v| are being calculated is missing.
Moreover, the calculation of the upper limit of the distribution for v² and |v|is unclear.
Suggested content improvement:
[x] extend class call with type hints
[x] add missing descriptions of keyword arguments in documentation
[x] potentially fix the calculation for the upper limits of the distribution for v² and |v| - or document behavior thoroughly
kay-ro
commented
1 month ago
Problem description:
The documentation of the
VelDistevaluation class is missing the description of several keyword arguments, namelyvmin,vmax,v2max. The description how the limits of the distribution for v² and |v| are being calculated is missing.Moreover, the calculation of the upper limit of the distribution for v² and |v|is unclear.
Suggested content improvement: