mantidproject / mantid

Main repository for Mantid code
https://www.mantidproject.org
GNU General Public License v3.0
211 stars 124 forks source link

Document the new utility module mantid.utils.reflectometry.orso_helper #38395

Closed jmborr closed 1 week ago

jmborr commented 1 week ago

Describe the outcome that is desired. A new page in Mantid documentation detailing the functionality of the module

Describe any solutions you are considering Branch isis_orso_docs_update has a draft of the documentation.

Additional context From the documentation draft:

The mantid.utils.reflectometry.orso_helper module provides functionality for reading and saving reflectivity data in ORSO (Open Reflectometry Standards Organization) format. It defines classes such as MantidORSOSaver, MantidORSODataset, and MantidORSODataColumns to facilitate the creation, manipulation, and saving of ORSO datasets. The MantidORSOSaver class manages the saving of datasets in ASCII or Nexus formats, while the MantidORSODataset class constructs the dataset with necessary metadata and data columns. Finally, the MantidORSODataColumns class handles the addition and management of data columns and their associated metadata. This module integrates with the Mantid framework to ensure that reflectivity data can be standardized and shared in compliance with ORSO specifications.