Better descriptive documentation

ambarb commented 3 years ago

made changes within /NeXus. mostly added more descriptive text, but this exercise uncovered a few questions.

Major changes

changed g2_stderr to g2_err to make it more generic --------- XPCS Eigen uses standard deviation in custom implementation based on their method. --------- skbeam requires end user to "experimentally" determine this --------- there is a mathematical-based error propagation method that can be employed
added error fields in NXxpcs/entry/twotime for extracted g2. this is NOT standard deviation so we should not label it as such.

Intentions for next version release

add pictures after this version release because future discussion could influence picture selection
added QUESTIONS for entire group to discuss

Next major decisions

how to deal with horizontal / vertical axis of 2D data
how to deal with 2d image origin
how to deal with 3D+ array data
how to deal with linked files versus array data
how to deal phi list

anyone should edit here if I have missed something

prjemian commented 3 years ago

One note, the <doc> tags in the NXDL file contain text that should follow the rules for restructured text (not XML). It's how NeXus passes this text to sphinx for building the documentation from the NXDL files.

prjemian commented 3 years ago

Let's look at the online rendering for comments on the content.

ambarb commented 2 years ago

going to close this for now so it doesn't get accidentally merged.

lightsources / BES-XPCS-Pilot