Data

Tools

Indexes

Applications

Experiments

Open Source Science

puzzlepiece

A GUI-forward Python framework for automating experimental setups.

https://github.com/jdranczewski/puzzlepiece

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 (9.9%) to scientific vocabulary

Keywords

automation experiment-automation experiment-control gui gui-framework
Last synced: 6 months ago · JSON representation ·

Repository

A GUI-forward Python framework for automating experimental setups.

Basic Info
Statistics
  • Stars: 4
  • Watchers: 1
  • Forks: 1
  • Open Issues: 5
  • Releases: 15
Topics
automation experiment-automation experiment-control gui gui-framework
Created over 2 years ago · Last pushed 8 months ago
Metadata Files
Readme License Citation

README.md

Puzzlepiece

Puzzlepiece is a GUI-forward Python framework for automating experimental setups. It focuses on abstracting communication with a piece of hardware into standard inputs, outputs, and actions. It then automatically generates GUI components for them, minimising the need for boilerplate code. Puzzlepiece allows the user to bring diverse controls into a single, consolidated application, and automate their interaction or experiment using a unified API, either by making custom Pieces, or through a built-in script language, or with Interactive Python.

See the documentation at https://puzzlepiece.readthedocs.io/ for examples of how to get started.

You can install puzzlepiece using pip: pip install puzzlepiece

Check out the examples folder for how to make an application (a Puzzle), and puzzlepiece/pieces/random_number.py for a simple example Piece. A Piece is a module that does a particular job (talks to a laser, scans a value, ...), and multiple of these brought together make up a Puzzle.

Created by Jakub Dranczewski as part of PhD work supported by the EU ITN EID project CORAL (GA no. 859841).

Owner

  • Name: Jakub Dranczewski
  • Login: jdranczewski
  • Kind: user
  • Location: London
  • Company: Imperial College London

Citation (CITATION.cff) 

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: puzzlepiece
message: Please cite this software using these metadata.
type: software
authors:
  - given-names: Jakub
    family-names: Dranczewski
    email: jbd17@ic.ac.uk
    orcid: 'https://orcid.org/0000-0002-8946-2214'
repository-code: 'https://github.com/jdranczewski/puzzlepiece'
url: 'https://puzzlepiece.readthedocs.io/'
license: Apache-2.0

GitHub Events

Total
  • Create event: 4
  • Release event: 2
  • Issues event: 8
  • Watch event: 3
  • Issue comment event: 2
  • Push event: 22
  • Pull request event: 6
Last Year
  • Create event: 4
  • Release event: 2
  • Issues event: 8
  • Watch event: 3
  • Issue comment event: 2
  • Push event: 22
  • Pull request event: 6

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 3
  • Total pull requests: 3
  • Average time to close issues: 2 months
  • Average time to close pull requests: 2 minutes
  • Total issue authors: 1
  • Total pull request authors: 2
  • Average comments per issue: 0.67
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 3
  • Pull requests: 3
  • Average time to close issues: 2 months
  • Average time to close pull requests: 2 minutes
  • Issue authors: 1
  • Pull request authors: 2
  • Average comments per issue: 0.67
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • jdranczewski (4)
Pull Request Authors
  • jdranczewski (4)
  • Squidwater606 (2)
Top Labels
Issue Labels
enhancement (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 18 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 15
  • Total maintainers: 1
pypi.org: puzzlepiece

A GUI-forward Python framework for automating experimental setups.

  • Versions: 15
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 18 Last month
Rankings
Dependent packages count: 7.5%
Forks count: 30.2%
Average: 36.6%
Stargazers count: 39.1%
Dependent repos count: 69.6%
Maintainers (1)
jdranczewski
Last synced: 6 months ago

Dependencies

requirements.txt pypi
  • numpy *
  • pyqtgraph *