lightlab

Laboratory Instrumentation and Automation

https://github.com/lightwave-lab/lightlab

Science Score: 46.0%

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

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    9 of 16 committers (56.3%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.4%) to scientific vocabulary
Last synced: 7 months ago · JSON representation

Repository

Laboratory Instrumentation and Automation

Basic Info
  • Host: GitHub
  • Owner: lightwave-lab
  • License: mit
  • Language: Jupyter Notebook
  • Default Branch: development
  • Size: 33.7 MB
Statistics
  • Stars: 50
  • Watchers: 7
  • Forks: 25
  • Open Issues: 9
  • Releases: 7
Created almost 8 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation

README.rst

Lightlab
========

.. image:: https://zenodo.org/badge/131508614.svg
   :target: https://zenodo.org/badge/latestdoi/131508614


A python library for remote laboratory control. Laboratory remoting facilitates experimental research:

* access from anywhere
* large dataset gathering, storage, and analysis
* repeatability
* real-time status and progress monitoring,
* intra- and inter-group collaboration

This package includes:

* A shared library of instrument drivers
* Representation of state for labs of multiple users
* Driver-independent abstractions of instruments
* Utilities for data structures, advanced sweeping, search procedures, spectrum analysis, and characterization
* Constructs of laboratory virtualization for repeatability and rapid user code development
* Detailed documentation of tips, tricks, and instructions for prepping your lab for remoting

Here is our `philosophy `__ of how a modern lab can look.

Installation
------------

From PyPI:

::

    pip install lightlab

From source (developer mode):

::

    git clone https://github.com/lightwave-lab/lightlab.git
    cd lightlab
    pip install -e .  # install in editable mode.

Getting started
---------------

1. Configure GPIB/ethernet communication on a `personal computer or instrumentation server `__
2. Initialize the representation of your `lab state `__
3. `Write a driver `__ or use an existing one
4. Read about advanced features and `tutorials `__
5. Get going! Need more help? Have suggestions? File an `issue `__

Readthedocs: `lightlab.readthedocs.io `_

Github: https://github.com/lightwave-lab/lightlab

Supported platforms
-------------------

Server: Mac OS and Linux running python3.6; not tested on Windows (to do).

Auxiliary hosts: Mac OS, Linux, Windows

Acknowledgements
----------------

This  material  is  based  in part upon  work  supported  by  the  National Science Foundation under Grant Number E2CDA-1740262. Any  opinions,  findings,  and  conclusions  or  recommendations expressed  in  this  material  are  those  of  the  author(s)  and  do  not necessarily reflect the views of the National Science Foundation.

Owner

  • Name: Lightwave Lab
  • Login: lightwave-lab
  • Kind: organization
  • Location: Princeton University

Research Group advised by Prof. Paul Prucnal

GitHub Events

Total
  • Watch event: 4
  • Member event: 1
  • Push event: 5
  • Pull request event: 4
Last Year
  • Watch event: 4
  • Member event: 1
  • Push event: 5
  • Pull request event: 4

Committers

Last synced: about 3 years ago

All Time
  • Total Commits: 739
  • Total Committers: 16
  • Avg Commits per committer: 46.188
  • Development Distribution Score (DDS): 0.494
Top Committers
Name Email Commits
Alex Tait a****t@p****u 374
Thomas Ferreira de Lima t****a@p****u 279
yechim y****m@p****u 41
Zhimu Guo 1****1@q****a 8
Thomas Ferreira de Lima g****b@t****e 8
aashuj a****j@p****u 7
dependabot[bot] 4****]@u****m 5
simbil s****0@p****u 3
Hsuan-Tung Peng h****g@n****U 3
Hsuan-Tung Peng h****g@p****u 3
simbilod 4****d@u****m 3
Florian Rathgeber f****r@g****m 1
Alex Tait a****t@i****g 1
Heidi Miller h****m@p****u 1
Sourcery AI 1
hughmor h****n@h****a 1

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 7
  • Total pull requests: 43
  • Average time to close issues: N/A
  • Average time to close pull requests: 3 months
  • Total issue authors: 3
  • Total pull request authors: 11
  • Average comments per issue: 0.14
  • Average comments per pull request: 0.7
  • Merged pull requests: 31
  • Bot issues: 0
  • Bot pull requests: 8
Past Year
  • Issues: 0
  • Pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: 21 minutes
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • thomaslima (5)
  • jclederman (1)
  • xunguan (1)
Pull Request Authors
  • thomaslima (14)
  • ZhimuG (8)
  • dependabot[bot] (8)
  • simbilod (4)
  • jclederman (4)
  • atait (2)
  • kynan (1)
  • hughmor (1)
  • joamatab (1)
  • jimohyusuf (1)
  • millerheidi (1)
Top Labels
Issue Labels
Pull Request Labels
dependencies (8)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 39 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 11
  • Total maintainers: 2
pypi.org: lightlab

Lightwave Lab instrument automation tools

  • Documentation: https://lightlab.readthedocs.io/
  • License: MIT License Copyright (c) 2018 Lightwave Lab, Princeton University Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  • Latest release: 1.1.1
    published about 3 years ago
  • Versions: 11
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 39 Last month
Rankings
Dependent packages count: 10.0%
Dependent repos count: 21.7%
Average: 23.0%
Downloads: 37.2%
Maintainers (2)
Last synced: 8 months ago

Dependencies

doc-requirements.txt pypi
  • Sphinx ==1.7.6
  • better-apidoc ==0.2.0
  • mock ==2.0.0
  • nbsphinx ==0.3.1
  • pytest ==3.7.1
  • recommonmark ==0.4.0
  • sphinx-autoapi ==0.5.0
  • sphinx-autobuild ==0.7.1
  • sphinx-rtd-theme ==0.4.1
  • sphinxcontrib-bibtex ==0.4.0
  • sphinxcontrib-napoleon ==0.6.1
.github/workflows/publish.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/test.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
pyproject.toml pypi
setup.py pypi
test-requirements.txt pypi
  • freezegun * test
  • mock * test
  • pytest * test
  • pytest-cov * test
  • pytest-flake8 * test
  • pytest-pylint * test