search

neutrons / PyRS

Reduction and visualization software for Stress Residual (HB2B)
https://neutrons-pyrs.readthedocs.io/en/latest/index.html
GNU General Public License v3.0
6 stars 7 forks source link

JOSS: please provide examples of how to use the software (ideally to solve real-world analysis problems). #780

Closed andyfaff closed 2 years ago

andyfaff commented 2 years ago

The JOSS instructions ask "do the authors include examples of how to use the software (ideally to solve real-world analysis problems)."

A brief overview of the types of processing enabled by the package (data reduction/analysis/autoreduction) is given in the paper and on readthedocs, but there are no clear cut examples given in either of those two sources.

fanchercm commented 2 years ago

An example has been added to the JOSS_ISSUE with data under the example folder. We have included information in an Example section in the readthedocs