#DistZilla: +PodWeaver
#PODNAME: Lab::Measurement::Manual
#ABSTRACT: API documentation manual for Lab::Measurement

__END__

=pod

=encoding UTF-8

=head1 NAME

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

=head1 VERSION

version 3.823

=head1 OVERVIEW

Currently, the Lab::Measurement API consists of:

=over

=item *

L</Lab::Moose>, the recommended, current API, based on B<Modern Perl>
techniques

=item *

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

=back

=head1 The Lab::Measurement package

=over

=item * L<Lab::Measurement::Installation>

=item * L<Lab::Measurement::Tutorial>

=item * L<Lab::Measurement::Backends>

=item * L<Lab::Measurement::Developer>

=item * L<Lab::Measurement::Examples::Example1_Simple_IV>

=item * L<Lab::Measurement::Examples::Example2_Gate_IV_scan>

=item * L<Lab::Measurement::Roadmap>

=back

=head2 High-level tool classes

=over

=item * L<Lab::Moose>

=item * L<Lab::Moose::DataFolder>

=item * L<Lab::Moose::DataFile>

=item * L<Lab::Moose::DataFile::Gnuplot>

=item * L<Lab::Moose::DataFile::Gnuplot::Compressed>

=item * L<Lab::Moose::DataFile::Meta>

=item * L<Lab::Moose::DataFile::Read>

=item * L<Lab::Moose::Plot>

=item * L<Lab::Moose::Countdown>

=item * L<Lab::Moose::Catfile>

=item * L<Lab::Moose::Stabilizer>

=back

=head2 Sweep classes

=over

=item * L<Lab::Moose::Sweep>

=item * L<Lab::Moose::Sweep::Step>

=item * L<Lab::Moose::Sweep::Step::Voltage>

=item * L<Lab::Moose::Sweep::Step::Frequency>

=item * L<Lab::Moose::Sweep::Step::Power>

=item * L<Lab::Moose::Sweep::Step::Magnet>

=item * L<Lab::Moose::Sweep::Step::Temperature>

=item * L<Lab::Moose::Sweep::Step::Repeat>

=item * L<Lab::Moose::Sweep::Step::Phase>

=item * L<Lab::Moose::Sweep::Step::Pulsewidth>

=item * L<Lab::Moose::Sweep::Step::Pulsedelay>

=item * L<Lab::Moose::Sweep::Continuous>

=item * L<Lab::Moose::Sweep::Continuous::Time>

=item * L<Lab::Moose::Sweep::Continuous::Magnet>

=item * L<Lab::Moose::Sweep::Continuous::Voltage>

=back

=head2 Instrument control classes

=over

=item * L<Lab::Moose::Instrument>

=item * L<Lab::Moose::Instrument::Cache>

=item * L<Lab::Moose::Instrument::Zhinst>

=back

=head3 Multimeters

=over

=item * L<Lab::Moose::Instrument::HP3458A>

=item * L<Lab::Moose::Instrument::HP34410A>

alias: L<Lab::Moose::Instrument::Agilent34410A>

=item * L<Lab::Moose::Instrument::Agilent34460A>

=item * L<Lab::Moose::Instrument::Keysight34470A>

=item * L<Lab::Moose::Instrument::HP34420A>

=item * L<Lab::Moose::Instrument::Keithley2000>

=back

=head3 Voltage sources

=over

=item * L<Lab::Moose::Instrument::YokogawaGS200>

=item * L<Lab::Moose::Instrument::Yokogawa7651>

=item * L<Lab::Moose::Instrument::KeysightE3633E>

=item * L<Lab::Moose::Instrument::DummySource>

=back

=head3 Source/Measure Units

=over

=item * L<Lab::Moose::Instrument::Keithley2400>

=item * L<Lab::Moose::Instrument::Keithley2450>

=item * L<Lab::Moose::Instrument::KeysightB2901A>

=back

=head3 Lock-in amplifiers

=over

=item * L<Lab::Moose::Instrument::SR830>

=item * L<Lab::Moose::Instrument::ZI_MFLI>

=item * L<Lab::Moose::Instrument::ZI_HF2LI>

=item * L<Lab::Moose::Instrument::SignalRecovery7265>

=item * L<Lab::Moose::Instrument::Synctek_MCL1_540>

=item * L<Lab::Moose::Instrument::ZI_MFIA>

=item * L<Lab::Moose::Instrument::AH2700A>

=back

=head3 RF generators

=over

=item * L<Lab::Moose::Instrument::RS_SMB>

=back

=head3 Spectrum analyzers

=over

=item * L<Lab::Moose::Instrument::RS_FSV>

=item * L<Lab::Moose::Instrument::HP8596E>

=item * L<Lab::Moose::Instrument::HPE4400B>

=item * L<Lab::Moose::Instrument::Rigol_DSA815>

=back

=head3 Network analyzers

=over

=item * L<Lab::Moose::Instrument::RS_ZVA>

=item * L<Lab::Moose::Instrument::RS_ZNL>

=item * L<Lab::Moose::Instrument::RS_ZVM>

=back

=head3 Superconducting magnet power supplies

=over

=item * L<Lab::Moose::Instrument::OI_Mercury::Magnet>

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

=item * L<Lab::Moose::Instrument::OI_IPS>

=item * L<Lab::Moose::Instrument::Cryomagnetics_4G> (work in progress)

=back

=head3 Helium and nitrogen liquid level meters

=over

=item * L<Lab::Moose::Instrument::OI_ILM210>

=back

=head3 Temperature control devices

=over

=item * L<Lab::Moose::Instrument::OI_Triton>

=item * L<Lab::Moose::Instrument::Lakeshore340>

=item * L<Lab::Moose::Instrument::Lakeshore340::Helium3>

=item * L<Lab::Moose::Instrument::Lakeshore350>

=item * L<Lab::Moose::Instrument::Lakeshore372>

=item * L<Lab::Moose::Instrument::OI_ITC503>

=item * L<Lab::Moose::Instrument::ABB_TRMC2>

=back

=head3 Oscilloscopes

=over

=item * L<Lab::Moose::Instrument::TBS1000C>

=item * L<Lab::Moose::Instrument::KeysightDSOS604A>

=back

=head3 Function/Waveform Generators

=over

=item * L<Lab::Moose::Instrument::Rigol_DG5000>

=back

=head3 Special

=over

=item * L<Lab::Moose::Instrument::NanonisTramea> (work in progress)

=back

=head2 Moose::Instrument Roles

=over

=item * L<Lab::Moose::Instrument::AdjustRange>

=item * L<Lab::Moose::Instrument::Common>

=item * L<Lab::Moose::Instrument::LinearStepSweep>

=item * L<Lab::Moose::Instrument::Log>

=item * L<Lab::Moose::Instrument::SCPIBlock>

=item * L<Lab::Moose::Instrument::VNASweep>

=item * L<Lab::Moose::Instrument::SpectrumAnalyzer>

=item * L<Lab::Moose::Instrument::OI_Common>

=item * L<Lab::Moose::Instrument::DisplayXY>

=item * L<Lab::Moose::Instrument::SCPI::Display::Window>

=item * L<Lab::Moose::Instrument::SCPI::Format>

=item * L<Lab::Moose::Instrument::SCPI::Initiate>

=item * L<Lab::Moose::Instrument::SCPI::Instrument>

=item * L<Lab::Moose::Instrument::SCPI::Output::State>

=item * L<Lab::Moose::Instrument::SCPI::Sense::Average>

=item * L<Lab::Moose::Instrument::SCPI::Sense::Bandwidth>

=item * L<Lab::Moose::Instrument::SCPI::Sense::Frequency>

=item * L<Lab::Moose::Instrument::SCPI::Sense::Function>

=item * L<Lab::Moose::Instrument::SCPI::Sense::Function::Concurrent>

=item * L<Lab::Moose::Instrument::SCPI::Sense::Impedance>

=item * L<Lab::Moose::Instrument::SCPI::Sense::NPLC>

=item * L<Lab::Moose::Instrument::SCPI::Sense::Null>

=item * L<Lab::Moose::Instrument::SCPI::Sense::Power>

=item * L<Lab::Moose::Instrument::SCPI::Sense::Protection>

=item * L<Lab::Moose::Instrument::SCPI::Sense::Range>

=item * L<Lab::Moose::Instrument::SCPI::Sense::Sweep>

=item * L<Lab::Moose::Instrument::SCPI::Source::Function>

=item * L<Lab::Moose::Instrument::SCPI::Source::Level>

=item * L<Lab::Moose::Instrument::SCPI::Source::Power>

=item * L<Lab::Moose::Instrument::SCPI::Source::Range>

=item * L<Lab::Moose::Instrument::SCPI::Unit>

=back

=head2 Connecting instruments

=over

=item * L<Lab::Moose::Connection>

=item * L<Lab::Moose::Connection::Mock>

=item * L<Lab::Moose::Connection::Debug>

=back

=head3 National Instruments VISA base class

=over

=item * L<Lab::Moose::Connection::VISA>

=back

=head3 GPIB (IEEE 488.2)

=over

=item * L<Lab::Moose::Connection::LinuxGPIB>

=item * L<Lab::Moose::Connection::VISA::GPIB>

alias: C<Lab::Moose::Connection::VISA_GPIB>

=item * L<Lab::Moose::Connection::WWW>

=back

=head3 USB Test & Measurement

=over

=item * L<Lab::Moose::Connection::USB>

=item * L<Lab::Moose::Connection::VISA::USB>

=back

=head3 Network socket

=over

=item * L<Lab::Moose::Connection::Socket>

=back

=head3 VXI-11

=over

=item * L<Lab::Moose::Connection::VXI11>

=item * L<Lab::Moose::Connection::VISA::VXI11>

=back

=head3 Zurich Instruments LabONE API

=over

=item * L<Lab::Moose::Connection::Zhinst>

=back

=head3 Oxford Instruments IsoBus

=over

=item * L<Lab::Moose::Connection::IsoBus>

=back

=head1 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.

=head1 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

=head1 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.

=cut
