Skip to main content
`Ctrl`+`K`

# RosettaSciIO documentation

The Rosetta Scientific Input Output library aims at providing easy reading and writing capabilities in Python for a wide range of scientific data formats. Thus providing an entry point to the wide ecosystem of python packages for scientific data analysis and computation, as well as an interoperability between different file formats. Just as the Rosetta stone provided a translation between ancient Egyptian hieroglyphs and ancient Greek. The RosettaSciIO library originates from the HyperSpy project for multi-dimensional data analysis. As HyperSpy is rooted in the electron microscopy community, data formats used by this community are still particularly well represented.

Getting Started

New to RosettaSciIO or Python? Find information on how to install RosettaSciIO.

Installation

Supported Formats

Overview of the different file formats that RosettaSciIO can read from and write to, as well as information on specific options if applicable.

Supported formats

Interoperability

Information on scripts and packages that allow opening data saved using RosettaSciIO with third-party programs.

Interoperability

File Specifications

Links to or documentation of file specifications for some of the formats supported by RosettaSciIO.

File Specifications

API Reference

Documentation describing how to use RosettaSciIO with other libraries than HyperSpy or for custom implementations using the Application Programming Interface (API).

API

Contributing

Information on how to implement new file plugins or help improve existing ones.

Contributing

RosettaSciIO provides the dataset, its axes and related metadata contained in a file in a python dictionary that can be easily handled by other libraries.

Note

RosettaSciIO has recently been split out of the HyperSpy repository and the new API is still under development. HyperSpy will use the RosettaSciIO IO-plugins from v2.0. It is already possible to import the readers directly from RosettaSciIO as follows:

    from rsciio import msa
    msa.file_reader("your_msa_file.msa")

## Citing RosettaSciIO

If RosettaSciIO has been significant to a project that leads to an academic publication, please acknowledge that fact by citing it. The DOI in the badge below is the Concept DOI – it can be used to cite the project without referring to a specific version. If you are citing RosettaSciIO because you have used it to process data, please use the DOI of the specific version that you have employed. You can find it by clicking on the DOI badge:

## Credits

RosettaSciIO is developed by an active community of contributors.

## Table of contents

- User Guide
  - Installation
  - Interoperability
- File Specifications
  - EDAX
  - Ripple (Lispix)
  - MRC (CCP-EM)
- Supported formats
- API
  - Interfacing the RosettaSciIO plugins
- Contributing
  - Issues
  - Making test data files
  - Pull Requests
  - Defining new RosettaSciIO plugins
  - RosettaSciIO version
  - Dependencies
  - Maintenance
- Release Notes
  - 0.7.1 (2025-01-12)
  - 0.7 (2024-12-20)
  - 0.6 (2024-07-11)
  - 0.5 (2024-06-15)
  - 0.4 (2024-04-02)
  - 0.3 (2023-12-12)
  - 0.2 (2023-11-09)
  - 0.1 (2023-06-06)
  - Initiation (2022-07-23)