Welcome to nspyre’s documentation!

https://img.shields.io/github/v/release/nspyre-org/nspyre?label=GitHub https://img.shields.io/pypi/v/nspyre https://img.shields.io/conda/v/conda-forge/nspyre https://img.shields.io/github/license/nspyre-org/nspyre https://readthedocs.org/projects/nspyre/badge/?version=latest https://img.shields.io/conda/pn/conda-forge/nspyre https://zenodo.org/badge/220515183.svg

(n)etworked (s)cientific (py)thon (r)esearch (e)nvironment

What is nspyre?

nspyre is a Python package for conducting scientific experiments. It provides a set of tools to allow for control of instrumentation, data collection, real-time plotting, as well as GUI generation. Anyone in the research or industrial spaces using computer-controlled equipment and collecting data can potentially benefit from using nspyre to run their experiments.

The hardware being controlled can be connected either locally on the machine running the experimental logic, or on a remote machine, which can be accessed in a simple, pythonic fashion. This allows for the easy integration of shared instrumentation in a research environment. Data collection is also networked, and allows for real-time viewing locally, or from a remote machine. nspyre provides a set of tools for quickly generating a Qt-based GUI for control and data viewing.

If you use nspyre for an experiment, we would really appreciate it if you (cite) it in your publication!

Who we are, and why we made nspyre

nspyre is primarily developed out of the Awschalom Group at the University of Chicago PME. We are an experimental quantum physics research lab with a focus on spin dynamics and quantum information processing. There are many software packages that seek to solve the same problems as nspyre. However, most suffer from being either:

  1. Designed for a very specific type of experiment at the expense of generality

  2. A commerical product that attempts to force users into buying the company’s proprietary equipment

nspyre is free and open-source (github). Its design intent aspires to the Unix philosophy. It attempts to give the user a set of helpful tools, without forcing them to run their experiment in any specific way. We hope that others will find this software useful, and will contribute to its development.

Indices and tables