Some common data preparation functions remain undocumented
Opened this issue · 1 comments
Some of the common data prep steps that are nicely implemented in XAS Viewer remain undocumented in the XAFS chapter. The ones I've stumbled upon are merging (larch.io.merge_groups) and smoothing operations (looks like there are several options under larch.math.utils).
This makes getting started with the larch python API a little difficult. While I managed to figure out the right function names, I think it wouldn't hurt to add equivalent documentation for this functionality, especially to explain why a user might choose one option over another.
@kaarelmand it would be great if you could add to the documentation directly by yourself what you are asking! Larch is an open source project and any help is welcome, especially on documentation.