PyVISA

PyVISA: the Python instrumentation package - Published in JOSS (2023)

https://github.com/pyvisa/pyvisa

Science Score: 100.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 7 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org
  • Committers with academic emails
    2 of 78 committers (2.6%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Keywords from Contributors

mesh exoplanet energy-system closember hydrology statistical-inference histfactory hep-ex frequentist-statistics cls
Last synced: 4 months ago · JSON representation ·

Repository

A Python package with bindings to the "Virtual Instrument Software Architecture" VISA library, in order to control measurement devices and test equipment via GPIB, RS232, or USB.

Basic Info
Statistics
  • Stars: 869
  • Watchers: 52
  • Forks: 260
  • Open Issues: 137
  • Releases: 5
Created over 12 years ago · Last pushed 4 months ago
Metadata Files
Readme Changelog Contributing Funding License Code of conduct Citation Authors

README.rst

PyVISA
======


.. image:: https://github.com/pyvisa/pyvisa/workflows/Continuous%20Integration/badge.svg
    :target: https://github.com/pyvisa/pyvisa/actions
    :alt: Continuous integration
.. image:: https://github.com/pyvisa/pyvisa/workflows/Documentation%20building/badge.svg
    :target: https://github.com/pyvisa/pyvisa/actions
    :alt: Documentation building
.. image:: https://dev.azure.com/pyvisa/pyvisa/_apis/build/status/pyvisa.keysight-assisted?branchName=main
    :target: https://dev.azure.com/pyvisa/pyvisa/_build
    :alt: Keysight assisted testing
.. image:: https://codecov.io/gh/pyvisa/pyvisa/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/pyvisa/pyvisa
    :alt: Code Coverage
.. image:: https://readthedocs.org/projects/pyvisa/badge/?version=latest
    :target: https://pyvisa.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status
.. image:: https://img.shields.io/pypi/l/PyVISA
    :target: https://pypi.python.org/pypi/pyvisa
    :alt: PyPI - License
.. image:: https://img.shields.io/pypi/v/PyVISA
    :target: https://pypi.python.org/pypi/pyvisa
    :alt: PyPI
.. image:: https://joss.theoj.org/papers/10.21105/joss.05304/status.svg
   :target: https://doi.org/10.21105/joss.05304


A Python package for support of the "Virtual Instrument Software
Architecture" (VISA), in order to control measurement devices and
test equipment via GPIB, RS232, Ethernet or USB.

Description
-----------

The programming of measurement instruments can be real pain. There are many
different protocols, sent over many different interfaces and bus systems
(GPIB, RS232, USB). For every programming language you want to use, you have to
find libraries that support both your device and its bus system.

In order to ease this unfortunate situation, the Virtual Instrument Software
Architecture (VISA_) specification was defined in the middle of the 90's. Today
VISA is implemented on all significant operating systems. A couple of vendors
offer VISA libraries, partly with free download. These libraries work together
with arbitrary peripheral devices, although they may be limited to certain
interface devices, such as the vendor’s GPIB card.

The VISA specification has explicit bindings to Visual Basic, C, and G
(LabVIEW’s graphical language). Python can be used to call functions from a
VISA shared library (`.dll`, `.so`, `.dylib`) allowing to directly leverage the
standard implementations. In addition, Python can be used to directly access
most bus systems used by instruments which is why one can envision to implement
the VISA standard directly in Python (see the `PyVISA-Py`_ project for more
details). PyVISA is both a Python wrapper for VISA shared libraries but
can also serve as a front-end for other VISA implementation such as
`PyVISA-Py`_.


.. _VISA: http://www.ivifoundation.org/specifications/default.aspx
.. _`PyVISA-Py`: http://pyvisa-py.readthedocs.io/en/latest/


VISA and Python
---------------

Python has a couple of features that make it very interesting for controlling
instruments:

- Python is an easy-to-learn scripting language with short development cycles.
- It represents a high abstraction level [2], which perfectly blends with the
  abstraction level of measurement programs.
- It has a rich set of native libraries, including numerical and plotting
  modules for data analysis and visualisation.
- A large set of books (in many languages) and on-line publications is
  available.


Requirements
------------

- Python (tested with 3.10+)
- VISA (tested with NI-VISA 17.5, Win7, from www.ni.com/visa and Keysight-VISA )

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

Using pip:

    $ pip install pyvisa

or easy_install:

    $ easy_install pyvisa

or download and unzip the source distribution file and:

    $ python setup.py install


Documentation
--------------

The documentation can be read online at https://pyvisa.readthedocs.org


Citing
------

If you are using this package, you can cite the `PyVISA publication`_

Grecco et al., (2023). PyVISA: the Python instrumentation package. Journal of Open Source
Software, 8(84), 5304, https://doi.org/10.21105/joss.05304

.. _`PyVISA publication`: https://joss.theoj.org/papers/10.21105/joss.05304#

Owner

  • Name: pyvisa
  • Login: pyvisa
  • Kind: organization

JOSS Publication

PyVISA: the Python instrumentation package
Published
April 27, 2023
Volume 8, Issue 84, Page 5304
Authors
Hernán E. Grecco ORCID
Universidad de Buenos Aires, Facultad de Ciencias Exactas y Naturales, Departamento de Física. Buenos Aires, Argentina., CONICET - Universidad de Buenos Aires, Instituto de Física de Buenos Aires (IFIBA). Buenos Aires, Argentina
Matthieu C. Dartiailh ORCID
Laboratoire Pierre Aigrain, Ecole Normale Supérieure. Paris, France, Center for Quantum Phenomena, New York University. New-York, NY, USA, Institut Néel, CNRS. Grenoble, France
Gregor Thalhammer-Thurner ORCID
Institute for Biomedical Physics, Medical University of Innsbruck, Austria
Torsten Bronger ORCID
Forschungszentrum Jülich GmbH (ROR 02nv7yv05). Jülich, Germany
Florian Bauer ORCID
Independent Researcher, Germany
Editor
Matthew Feickert ORCID
Tags
instrumentation VISA measurement acquisition experiment control hardware communication GPIB SERIAL TCP/IP USBTMC VXI PXI

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Grecco"
  given-names: "Hernán E."
  orcid: "https://orcid.org/0000-0002-1165-4320"
- family-names: "Dartiailh"
  given-names: "Matthieu C."
  orcid: "https://orcid.org/0000-0001-6451-0577"
- family-names: "Thalhammer-Thurner"
  given-names: "Gregor"
  orcid: "https://orcid.org/0000-0002-3948-8045"
- family-names: "Bronger"
  given-names: "Torsten"
  orcid: "https://orcid.org/0000-0002-5174-6684"
- family-names: "Bauer"
  given-names: "Florian"
  orcid: "https://orcid.org/0009-0004-5271-5363"
title: "PyVISA"
version: 1.13.0
doi: 10.5281/zenodo.7868199
date-released: 2022-12-22
url: "https://github.com/github-linguist/linguist"
preferred-citation:
  type: article
  authors:
  - family-names: "Grecco"
    given-names: "Hernán E."
    orcid: "https://orcid.org/0000-0002-1165-4320"
  - family-names: "Dartiailh"
    given-names: "Matthieu C."
    orcid: "https://orcid.org/0000-0001-6451-0577"
  - family-names: "Thalhammer-Thurner"
    given-names: "Gregor"
    orcid: "https://orcid.org/0000-0002-3948-8045"
  - family-names: "Bronger"
    given-names: "Torsten"
    orcid: "https://orcid.org/0000-0002-5174-6684"
  - family-names: "Bauer"
    given-names: "Florian"
    orcid: "https://orcid.org/0009-0004-5271-5363"
  doi: "10.21105/joss.05304"
  journal: "Journal of Open Source Software"
  month: 4
  start: 5304
  end: 5308 
  title: "PyVISA: the Python instrumentation package"
  issue: 84
  volume: 8
  year: 2023

GitHub Events

Total
  • Issues event: 35
  • Watch event: 63
  • Delete event: 34
  • Issue comment event: 121
  • Push event: 56
  • Pull request review comment event: 5
  • Pull request review event: 9
  • Pull request event: 79
  • Fork event: 10
  • Create event: 29
Last Year
  • Issues event: 35
  • Watch event: 63
  • Delete event: 34
  • Issue comment event: 121
  • Push event: 56
  • Pull request review comment event: 5
  • Pull request review event: 9
  • Pull request event: 79
  • Fork event: 10
  • Create event: 29

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 1,369
  • Total Committers: 78
  • Avg Commits per committer: 17.551
  • Development Distribution Score (DDS): 0.736
Past Year
  • Commits: 63
  • Committers: 11
  • Avg Commits per committer: 5.727
  • Development Distribution Score (DDS): 0.302
Top Committers
Name Email Commits
MatthieuDartiailh m****l@l****t 362
Hernan Grecco h****o@g****m 350
bronger b****r@5****d 323
bauflo3 b****3@5****d 58
pre-commit-ci[bot] 6****] 58
Christian Lupien c****n@u****a 22
skrchnavy s****y@a****m 21
dependabot[bot] 4****] 14
gth g****h@5****d 12
Dmitry Stepanov a****s@l****u 11
Carsten Sauerbrey c****y@g****m 11
Bob McNamara 7****a 11
Max Barnash m****x@b****h 10
acopelan a****d@k****m 8
Kenny Huynh h****v@g****m 6
Mike Chwang m****h@g****m 4
Fabio Rossi r****f@i****t 3
Martin Ritter r****r@m****e 3
Matthew Feickert m****t@c****h 3
km4yri k****i@g****m 3
monticello0427 3****7 3
Sveto Krchnavy s****y@g****m 3
Bob McNamara r****m@r****m 3
Hermann Kraus h****t@g****m 2
Hugo h****k 2
Laurent P. René de Cotret l****t@o****m 2
Matthew Swabey m****w@s****g 2
Matthew94 m****4@g****m 2
Yves Delley h****k@d****t 2
bernizt b****t@g****m 2
and 48 more...

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 66
  • Total pull requests: 156
  • Average time to close issues: 5 months
  • Average time to close pull requests: 27 days
  • Total issue authors: 63
  • Total pull request authors: 16
  • Average comments per issue: 5.76
  • Average comments per pull request: 0.92
  • Merged pull requests: 121
  • Bot issues: 0
  • Bot pull requests: 123
Past Year
  • Issues: 25
  • Pull requests: 109
  • Average time to close issues: 3 days
  • Average time to close pull requests: 3 days
  • Issue authors: 23
  • Pull request authors: 10
  • Average comments per issue: 0.88
  • Average comments per pull request: 0.52
  • Merged pull requests: 84
  • Bot issues: 0
  • Bot pull requests: 90
Top Authors
Issue Authors
  • spevs (2)
  • dazz100 (2)
  • j-ruhi (2)
  • dilrukshi924 (1)
  • drmcnelson (1)
  • paniash (1)
  • gentle-giant (1)
  • tmis93 (1)
  • Xander-Ault (1)
  • saclif (1)
  • NabilaTasnim (1)
  • sagregrevc (1)
  • Jonjinadsf (1)
  • schlatterbeck (1)
  • StevenGoode (1)
Pull Request Authors
  • pre-commit-ci[bot] (105)
  • dependabot[bot] (18)
  • MatthieuDartiailh (7)
  • bobmcnamara (4)
  • arr-ee (3)
  • aWZHY0yQH81uOYvH (2)
  • jllanfranchi (2)
  • cwstryker (2)
  • purnimab (2)
  • henriquesimoes (2)
  • InSyncWithFoo (2)
  • dphaas (2)
  • spevs (2)
  • juggernaut545 (1)
  • natezb (1)
Top Labels
Issue Labels
instrument (27)
Pull Request Labels
dependencies (18) github_actions (8)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 495,349 last-month
  • Total dependent packages: 110
  • Total dependent repositories: 252
  • Total versions: 26
  • Total maintainers: 4
pypi.org: pyvisa

Python VISA bindings for GPIB, RS232, TCPIP and USB instruments

  • Documentation: https://pyvisa.readthedocs.io/
  • License: The MIT License Copyright (c) 2005-2024 PyVISA Authors and contributors. See AUTHORS 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.15.0
    published 9 months ago
  • Versions: 26
  • Dependent Packages: 110
  • Dependent Repositories: 252
  • Downloads: 495,349 Last month
Rankings
Dependent packages count: 0.2%
Average: 0.6%
Downloads: 0.6%
Dependent repos count: 1.0%
Last synced: 4 months ago

Dependencies

dev-requirements.txt pypi
  • black * development
  • flake8 * development
  • isort * development
  • mypy * development
  • sphinx * development
  • sphinx-rtd-theme * development
docs/requirements.txt pypi
  • sphinx >=4
  • sphinx-rtd-theme >=1
.github/workflows/ci.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v3 composite
.github/workflows/docs.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • ts-graphviz/setup-graphviz v1 composite
.github/workflows/release.yml actions
  • actions/checkout v3 composite
  • actions/create-release v1 composite
  • actions/download-artifact v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • pypa/gh-action-pypi-publish master composite
  • shogo82148/actions-upload-release-asset v1 composite
pyproject.toml pypi
  • typing_extensions *
setup.py pypi