rosettasciio icon indicating copy to clipboard operation
rosettasciio copied to clipboard

Document public API to access plugins information

Open ericpre opened this issue 6 months ago • 1 comments

  • Document API to access plugins information needs to be documented - see https://github.com/hyperspy/hyperspy/pull/3525#discussion_r2171224035 for context.
  • Add functionality for user to get this information in a table format, etc. Use this table in the documentation to make sure the documentation is accurate.

ericpre avatar Jun 27 '25 10:06 ericpre

Maybe this is a two parter. 1st mayber we should add a load function to rosettasciio that chooses the right fileformat etc like hyperspy. The whole import a file loader etc get's a bit tedius.

Something like `rsciio.load("file.mrc")

Then we should add a function hs.load.info(".mrc") / rsciio.load.info(".mrc") which returns a nicely formatted table with the information from the .yaml as well as all of the potential **kwargs

CSSFrancis avatar Jul 02 '25 20:07 CSSFrancis