Skip to content
This repository has been archived by the owner on May 31, 2024. It is now read-only.

Add Renishaw-WDF and associated RosettaSciIO parser #45

Merged
merged 1 commit into from
Oct 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions marda_registry/data/extractors/rosettasciio.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
id: >-
rosettaasciio
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this not a typo?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes

name: >-
RosettaSciIO
description: >-
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.
supported_filetypes:
- id: renishaw-wdf
license:
spdx: GPL-3.0-only
subject:
- raman
- electron-microscopy
- imaging
citations:
- uri: doi:10.5281/zenodo.592838
title: HyperSpy
type: software
source_repository: https://github.com/hyperspy/rosettasciio
documentation: https://hyperspy.org/rosettasciio
usage:
- method: python
setup: rsciio
command: rsciio.renishaw.file_reader({{ input_path }})
description: >-
This usage instruction is specifically for the renishaw-wdf file type.
installation:
- method: pip
packages:
- rosettasciio
- method: pip
packages:
- git+https://github.com/hyperspy/rosettasciio
instructions: >-
Install the package into a Python 3.9+ environment with
`pip install yadg`. After activating the environment, the
`extract` entrypoint will be available at the command-line.
20 changes: 20 additions & 0 deletions marda_registry/data/filetypes/renishaw-wdf.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
id: >-
renishaw-wdf
name: >-
Renishaw WDF file
description: >-
A binary data file created by Renishaw Raman microscopes, optimised to handle
very large datasets of multiple (millions) of Raman spectra taken at points of
an optical image.
associated_vendors:
- Renishaw
subject:
- raman
- microscopy
associated_instruments:
- Renishaw inVia confocal Raman microscope
- Renishaw Virsa Raman analyser
- Renishaw RA800 benchtop Raman analyser
associated_software:
- Renishaw Windows-based Raman Environment (WiRE)