Python scientific measurement toolbox
Pyscan is an instrument control and measurement tool box for scientific laboratory instruments.
It provides tools to create "experiments," in which you can interface with devices, define a measurement function with which to collect data from the devices, and run an experiment to "loop" over multiple variables or properties. The data can be plotted live so the experimenter can observe data collection during the experiment, and once complete, the data and metadata with all experimental parameters are automatically saved to a h5py file. Such files can be loaded and the data can be plotted again at a later time.
A selection of instrument drivers are included, but drivers from other libraries can also be used with pyscan.
Pyscan can be installed by downloading this repository and following the instructions below.
- Jupyter Lab (recommended interface to run experiments using pyscan), automatically installed through Anaconda
- It is also recommended to install and use pyscan in a virtual environment
- conda or python must be accessable from the terminal or anaconda prompt
-
Use git to clone this repository into your computer.
-
Open a terminal or anaconda prompt window. Navigate to the pyscan folder, which contains the file "setup.py".
-
Install pyscan with
pip install ./
Sample Jupyter Notebooks running dummy experiments are located in the demo_notebooks folder.
For the full instructions on how to use pyscan library, read the docs! (Coming Soon)
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
If Pyscan contributes to a project that leads to publication, please acknowledge this by citing Pyscan.