Data

Tools

Indexes

Applications

Experiments

Open Source Science

ambiguous-resonances-dataset

https://github.com/qiss-hzb/ambiguous-resonances-dataset

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 1 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: aps.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.7%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: QISS-HZB
  • License: gpl-3.0
  • Language: Python
  • Default Branch: main
  • Size: 333 KB
Statistics
  • Stars: 2
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 1 year ago · Last pushed 12 months ago
Metadata Files
Readme License Citation

README.md

Ambiguous Resonances Dataset

This repository contains the Python script for the graphical user interface (GUI) application of the dataset from the paper Ambiguous Resonances in Multipulse Quantum Sensing with Nitrogen Vacancy Centers in Diamonds by L. Tsunaki et al, available at: https://journals.aps.org/pra/abstract/10.1103/PhysRevA.111.022606

It is used to visualize and analyze the simulations of ambiguous resonances contained in the dataset, available at https://figshare.com/articles/dataset/Dataset_for_Ambiguous_Resonances_in_Multipulse_Quantum_Sensing_with_NVs/26245895 or https://box.fu-berlin.de/s/ajm6wijbKWJQKQS

In this GUI, the user can choose specific experimental parameters and compare with experimental data.

Screenshot of the GUI

Setup

The application provides a GUI based on the Python bindings for Qt6. It depends on NumPy, Matplotlib, PyQt6/PySide6, andPyTables. Thus, we recommend creating a conda virtual environment with:

sh conda create --name dataset-env python numpy matplotlib pyside6 pytables conda activate dataset-env

Usage

Download the HDF5 file from here or here and place it in the same directory as the script.

Optional: verify the integrity of the downloaded dataset ## sha256 checksum To make sure that the dataset was downloaded correctly, we provide the sha256 checksum. Run `sha256sum dataset.h5` on the downloaded file to obtain the checksum. It should match `94fd4c725c1353ac68a4102e8f825a59766bcafe5f6e140915a94df084845937`.

And then to launch the GUI, one can simply run the following command in the cloned repository within the conda environment:

sh python dataset_gui.py

This will launch the GUI with the standard HDF5 file. However, if the user wants to have a different dataset file, the –-dataset flag can be used as follows:

python dataset_gui.py --dataset /PATH/CUSTOM_DATASET.hdf5

The use of the GUI is intuitive and self-explanatory. There are two tabs, one for 15N and the other for 13C ambiguous resonances. The $ms$ state of the electronic spin transition should be chosen, with the order $M$ of the XY8 sequence, the bias magnetic field $B0$, minimum and maximum $\tau$ or $f$ range. In addition, for 15N, the angle $\theta$ must be specified and for 13C, the carbon families. The expected resonances from the gyromagnetic ratios of other nuclear spins can also be compared with.

A text file with experimental data can be plotted together with the simulation for spectral disambiguation, with the conditions that it can be read by numpy.loadtxt and its first column representing $\tau$ or $f$ in the correct units and the second indicating the XY8 intensity. Finally, the plot can be customized and exported.

New simulations for ambiguous resonances are intended to be added to the dataset in the following months of the publishing of this paper. Depending on user feedback, the GUI might also undergo alterations.

Structure of the HDF5 file

The HDF5 file contains 3 groups, one each for 15N, 13C, and constants. The table structure for the data is:

15N: n15_group

| order | field | field_angle | ms | data | rabi | |-------|-------|-------------|-----|------|------| | ... | ... | ... | ... | ... | ... |

order: order of the XY8 sequence
field: static magnetic field in mT
field_angle: field misalignment angle in degrees
ms: spin state excited (+1 or -1)
data: the time series data for the simulated fluorescence
rabi: 1 indicates an uncertain Rabi period from the fit

13C: c13_group

| order | fam | field | ms | data | rabi | |-------|-----|-------|-----|------|------| | ... | ... | ... | ... | ... | ... |

order: order of the XY8 sequence
fam: 13C family
field: static magnetic field in mT
ms: spin state excited (+1 or -1)
data: the time series data for the simulated fluorescence
rabi: 1 indicates an uncertain Rabi period from the fit

Owner

  • Name: QISS-HZB
  • Login: QISS-HZB
  • Kind: organization

Citation (CITATION.cff) 

cff-version: 1.2.0
title: Ambiguous Resonances Dataset
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Anmol
    family-names: Singh
    email: anmol.singh@helmholtz-berlin.de
    orcid: 'https://orcid.org/0009-0000-1578-626X'
    affiliation: Helmholtz Zentrum Berlin
  - given-names: Lucas
    email: lucas.tsunaki@helmholtz-berlin.de
    affiliation: Helmholtz Zentrum Berlin
    family-names: Tsunaki
    orcid: 'https://orcid.org/0009-0003-3534-6300'
identifiers:
  - type: doi
    value: 10.1103/PhysRevA.111.022606
repository-code: 'https://github.com/QISS-HZB/ambiguous-resonances-dataset'
repository-artifact: >-
  https://figshare.com/articles/dataset/Dataset_for_Ambiguous_Resonances_in_Multipulse_Quantum_Sensing_with_NVs/26245895
license: GPL-3.0
version: '2.0'

GitHub Events

Total
  • Watch event: 1
  • Push event: 2
Last Year
  • Watch event: 1
  • Push event: 2