Data

Tools

Indexes

Applications

Experiments

Open Source Science

naqs_devices_template_device

Template repository for creating and integrating a labscript device

https://github.com/naqslab/naqs_devices_template_device

Science Score: 44.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
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (8.3%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Template repository for creating and integrating a labscript device

Basic Info
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created 11 months ago · Last pushed 8 months ago
Metadata Files
Readme License Citation

README.md

naqsdevicestemplate_device

This repository is both a template to follow for a labscript-device belonging to a namespace (here naqs_devices) as well as a github template repository. Use the green Use this template button above to copy the files and structure of this repository to fit your new device. You will need to modify at least pyproject.toml, README.md, index.rst, conf.py, and everything in src/.

Directory structure

```text

└── naqsdevicestemplatedevice/ ├── .gitignore ├── pyproject.toml ├── README.md ├── LICENSE.txt # Choose a license, labscript uses BSD ├── CITATION.cff # Optional to define citation for citing the device repository ├── docs/ │ ├── conf.py │ ├── make.bat │ ├── Makefile │ └── index.rst └── src/naqsdevices/ # note: must be same as in the parent naqsdevices repo to be in the same namespace └── TemplateDevice/ ├── _init_.py ├── blacstabs.py ├── blacsworkers.py ├── labscriptdevices.py ├── registerclasses.py └── runviewerparsers.py ```

How to document your device

To work within the labscript paradigm, we enforce that you write all specification related documentation in the top-level README.md (here). Then, any API related documentation should go in the docs/index.rst. The project is structured and has the machinery so that the device can be hosted on Read The Docs. This is optional and requires extra configuration steps as outlined in the RTD Docs.

Owner

  • Name: NAQS Lab
  • Login: naqslab
  • Kind: organization

Citation (CITATION.cff) 

cff-version: 1.2.0
message: If you use this software, please cite it using the preferred article citation.
title: dds-sweeper
abstract: >-
  Raspberry Pi Pico interface for the AD9959 DDS
authors:
  - family-names: Huegler
    given-names: Ethan
    orcid: 'https://orcid.org/0000-0001-5075-970X'
  - family-names: Hill
    given-names: Joshua C
    orcid: 'https://orcid.org/0000-0002-4978-5393'
  - family-names: Meyer
    given-names: David H
    orcid: 'https://orcid.org/0000-0003-2452-2017'

version: 0.1.1
date-released: "2023-02-01"
license: BSD
repository-code: "https://github.com/QTC-UMD/dds-sweeper"
url: "https://doi.org/10.1063/5.0163342"

identifiers:
  - description: Journal article describing the software
    doi: 10.1063/5.0163342

preferred-citation:
  type: article
  title: "An agile radio-frequency source using internal linear sweeps of a direct digital synthesizer"
  authors:
    - family-names: Huegler
      given-names: Ethan
      orcid: 'https://orcid.org/0000-0001-5075-970X'
    - family-names: Hill
      given-names: Joshua C
      orcid: 'https://orcid.org/0000-0002-4978-5393'
    - family-names: Meyer
      given-names: David H
      orcid: 'https://orcid.org/0000-0003-2452-2017'
  doi: "10.1063/5.0163342"
  journal: "Review of Scientific Instruments"
  month: 9
  year: 2023
  start: 94705 # page number
  issue: 94

references:
  - type: software
    title: PrawnBlaster
    authors:
      - family-names: Starkey
        given-names: Philip
    repository-code: "https://github.com/labscript-suite/PrawnBlaster"

GitHub Events

Total
  • Watch event: 1
  • Push event: 6
  • Public event: 1
Last Year
  • Watch event: 1
  • Push event: 6
  • Public event: 1

Dependencies

pyproject.toml pypi
  • blacs >=3.0.0
  • h5py *
  • labscript >=3.0.0
  • labscript_devices >=3.0.0
  • labscript_utils >=3.0.0
  • naqs_devices @ git+https://github.com/naqslab/naqs_devices.git
  • numpy >=1.15.1