NAME

Lab::Measurement::Manual - API documentation manual for Lab::Measurement

VERSION

version 3.840

OVERVIEW

Currently, the Lab::Measurement API consists of:

• "Lab::Moose", the recommended, current API, based on Modern Perl techniques

• the historical API, consisting of the Lab::Instrument virtual instruments and the high-level Lab::XPRESS interface

The Lab::Measurement package

• Lab::Measurement::Installation

• Lab::Measurement::Tutorial

• Lab::Measurement::Backends

• Lab::Measurement::Developer

• Lab::Measurement::Examples::Example1_Simple_IV

• Lab::Measurement::Examples::Example2_Gate_IV_scan

• Lab::Measurement::Roadmap

High-level tool classes

• Lab::Moose

• Lab::Moose::DataFolder

• Lab::Moose::DataFile

• Lab::Moose::DataFile::Gnuplot

• Lab::Moose::DataFile::Gnuplot::Compressed

• Lab::Moose::DataFile::Meta

• Lab::Moose::DataFile::Read

• Lab::Moose::Plot

• Lab::Moose::Countdown

• Lab::Moose::Catfile

• Lab::Moose::Stabilizer

Sweep classes

• Lab::Moose::Sweep

• Lab::Moose::Sweep::Step

• Lab::Moose::Sweep::Step::Voltage

• Lab::Moose::Sweep::Step::Frequency

• Lab::Moose::Sweep::Step::Power

• Lab::Moose::Sweep::Step::Magnet

• Lab::Moose::Sweep::Step::Temperature

• Lab::Moose::Sweep::Step::Repeat

• Lab::Moose::Sweep::Step::Phase

• Lab::Moose::Sweep::Step::Pulsewidth

• Lab::Moose::Sweep::Step::Pulsedelay

• Lab::Moose::Sweep::Continuous

• Lab::Moose::Sweep::Continuous::Time

• Lab::Moose::Sweep::Continuous::Magnet

• Lab::Moose::Sweep::Continuous::Voltage

Instrument control classes

• Lab::Moose::Instrument

• Lab::Moose::Instrument::Cache

• Lab::Moose::Instrument::Zhinst

Multimeters

• Lab::Moose::Instrument::HP3458A

• Lab::Moose::Instrument::HP34410A

  alias: Lab::Moose::Instrument::Agilent34410A

• Lab::Moose::Instrument::Agilent34460A

• Lab::Moose::Instrument::Keysight34470A

• Lab::Moose::Instrument::HP34420A

• Lab::Moose::Instrument::Keithley2000

Voltage sources

• Lab::Moose::Instrument::YokogawaGS200

• Lab::Moose::Instrument::Yokogawa7651

• Lab::Moose::Instrument::KeysightE3633E

• Lab::Moose::Instrument::DummySource

Source/Measure Units

• Lab::Moose::Instrument::Keithley2400

• Lab::Moose::Instrument::Keithley2450

• Lab::Moose::Instrument::KeysightB2901A

Lock-in amplifiers

• Lab::Moose::Instrument::SR830

• Lab::Moose::Instrument::ZI_MFLI

• Lab::Moose::Instrument::ZI_HF2LI

• Lab::Moose::Instrument::SignalRecovery7265

• Lab::Moose::Instrument::Synctek_MCL1_540

• Lab::Moose::Instrument::ZI_MFIA

• Lab::Moose::Instrument::AH2700A

RF generators

• Lab::Moose::Instrument::RS_SMB

Spectrum analyzers

• Lab::Moose::Instrument::RS_FSV

• Lab::Moose::Instrument::HP8596E

• Lab::Moose::Instrument::HPE4400B

• Lab::Moose::Instrument::Rigol_DSA815

Network analyzers

• Lab::Moose::Instrument::RS_ZVA

• Lab::Moose::Instrument::RS_ZNL

• Lab::Moose::Instrument::RS_ZVM

Superconducting magnet power supplies

• Lab::Moose::Instrument::OI_Mercury::Magnet

  contains support for temperature sensor and He/N2 level meters.

• Lab::Moose::Instrument::OI_IPS

• Lab::Moose::Instrument::Cryomagnetics_4G (work in progress)

Helium and nitrogen liquid level meters

• Lab::Moose::Instrument::OI_ILM210

Temperature control devices

• Lab::Moose::Instrument::OI_Triton

• Lab::Moose::Instrument::Lakeshore340

• Lab::Moose::Instrument::Lakeshore340::Helium3

• Lab::Moose::Instrument::Lakeshore350

• Lab::Moose::Instrument::Lakeshore372

• Lab::Moose::Instrument::OI_ITC503

• Lab::Moose::Instrument::ABB_TRMC2

Oscilloscopes

• Lab::Moose::Instrument::TBS1000C

• Lab::Moose::Instrument::KeysightDSOS604A

• Lab::Moose::Instrument::RS_RTB2000

Function/Waveform Generators

• Lab::Moose::Instrument::Rigol_DG5000

• Lab::Moose::Instrument::Keysight33600

• Lab::Moose::Instrument::HP83732A

Special

• Lab::Moose::Instrument::NanonisTramea (work in progress)

• Lab::Moose::Instrument::ProStep4 (work in progress)

Moose::Instrument Roles

• Lab::Moose::Instrument::AdjustRange

• Lab::Moose::Instrument::Common

• Lab::Moose::Instrument::LinearStepSweep

• Lab::Moose::Instrument::Log

• Lab::Moose::Instrument::SCPIBlock

• Lab::Moose::Instrument::VNASweep

• Lab::Moose::Instrument::SpectrumAnalyzer

• Lab::Moose::Instrument::OI_Common

• Lab::Moose::Instrument::DisplayXY

• Lab::Moose::Instrument::SCPI::Display::Window

• Lab::Moose::Instrument::SCPI::Format

• Lab::Moose::Instrument::SCPI::Initiate

• Lab::Moose::Instrument::SCPI::Instrument

• Lab::Moose::Instrument::SCPI::Output::State

• Lab::Moose::Instrument::SCPI::Sense::Average

• Lab::Moose::Instrument::SCPI::Sense::Bandwidth

• Lab::Moose::Instrument::SCPI::Sense::Frequency

• Lab::Moose::Instrument::SCPI::Sense::Function

• Lab::Moose::Instrument::SCPI::Sense::Function::Concurrent

• Lab::Moose::Instrument::SCPI::Sense::Impedance

• Lab::Moose::Instrument::SCPI::Sense::NPLC

• Lab::Moose::Instrument::SCPI::Sense::Null

• Lab::Moose::Instrument::SCPI::Sense::Power

• Lab::Moose::Instrument::SCPI::Sense::Protection

• Lab::Moose::Instrument::SCPI::Sense::Range

• Lab::Moose::Instrument::SCPI::Sense::Sweep

• Lab::Moose::Instrument::SCPI::Source::Function

• Lab::Moose::Instrument::SCPI::Source::Level

• Lab::Moose::Instrument::SCPI::Source::Power

• Lab::Moose::Instrument::SCPI::Source::Range

• Lab::Moose::Instrument::SCPI::Unit

Connecting instruments

• Lab::Moose::Connection

• Lab::Moose::Connection::Mock

• Lab::Moose::Connection::Debug

National Instruments VISA base class

• Lab::Moose::Connection::VISA

GPIB (IEEE 488.2)

• Lab::Moose::Connection::LinuxGPIB

• Lab::Moose::Connection::VISA::GPIB

  alias: Lab::Moose::Connection::VISA_GPIB

• Lab::Moose::Connection::WWW

USB Test & Measurement

• Lab::Moose::Connection::USB

• Lab::Moose::Connection::VISA::USB

Network socket

• Lab::Moose::Connection::Socket

VXI-11

• Lab::Moose::Connection::VXI11

• Lab::Moose::Connection::VISA::VXI11

Zurich Instruments LabONE API

• Lab::Moose::Connection::Zhinst

Oxford Instruments IsoBus

• Lab::Moose::Connection::IsoBus

Legacy Lab::Measurement API

This part is deprecated and will be removed with Lab::Measurement 3.9. Please base new measurements on the Moose-based API and port your old scripts. For documentation, see the module files.

CITING Lab::Measurement

If you use Lab::Measurement in your work, we would appreciate very much a citation in the resulting publications. Please cite us as follows:

"Lab::Measurement — a portable and extensible framework for controlling lab equipment and conducting measurements", S. Reinhardt, C. Butschkow, S. Geissler, A. Dirnaichner, F. Olbrich, C. Lane, D. Schröer, and A. K. Hüttel, Computer Physics Communications 234, 216 (2019); doi:10.1016/j.cpc.2018.07.024

COPYRIGHT AND LICENSE

This software is copyright (c) 2022 by the Lab::Measurement team; in detail:

Copyright 2017       Simon Reinhardt
          2018       Andreas K. Huettel, Simon Reinhardt
          2019       Simon Reinhardt
          2020       Andreas K. Huettel, Sam Bingner, Simon Reinhardt
          2021       Andreas K. Huettel, Fabian Weinelt, Simon Reinhardt
          2022       Andreas K. Huettel, Mia Schambeck, Simon Reinhardt

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

cpanm Lab::Measurement

perl -MCPAN -e shell
install Lab::Measurement