Once issue #1 is complete, we will have an example showing users how to put together sidpy.Reader classes.
Contributors could use this example as a basis for converting Translator classes in pycroscopy.io.translators to sidpy.Reader classes. The Reader class is almost identical to the Translator class.
The majority of the effort would be in converting file writing portions of the code to populating sidpy.Dataset objects and returning these objects instead.
Note - Do not migrate CNMS-specific Band Excitation or General Mode Translators to ScopeReaders. These have already been copied over to BGlib and are likely better off remaining as Translators due to their complexity.
Once issue #1 is complete, we will have an example showing users how to put together
sidpy.Reader
classes. Contributors could use this example as a basis for convertingTranslator
classes inpycroscopy.io.translators
tosidpy.Reader
classes. TheReader
class is almost identical to theTranslator class
.The majority of the effort would be in converting file writing portions of the code to populating
sidpy.Dataset
objects and returning these objects instead.Note - Do not migrate CNMS-specific Band Excitation or General Mode
Translators
toScopeReaders
. These have already been copied over to BGlib and are likely better off remaining asTranslators
due to their complexity.