matlab-qd

A framework to write high-level instrument drivers, to do basic measurement, and to quickly browse the resulting data. This is a direct competitor to special-measure.

Important notice

The API is under development. Changes likely to cause problems for users will be recorded in the file BREAKING_CHANGES.md. Please watch this when updating the package. In addition, you should restart daemons and clear your matlab workspaces after updating (unless you know better).

Installation

matlab-qd depends on a few other libraries. To install them, run the following command in a git shell:

git submodule update --init

Then add the root folder of the library to the MATLAB path, as well as all the folders immediately inside the dependencies folder. Run the command zmq.install_jar in MATLAB.

Some equipment needs continuously running daemons, see Configuring Daemons.

Usage

See the tutorial. Note, if you plan to contribute code to the project, then the tutorial is mandatory reading.

A sequential run example is here: SequentialRun.md.

Documentation

Find help and information here:

• The Tutorial
• The doc command in MATLAB. E.g. type doc qd.classes.Instrument
• List of breaking changes
• Configuring Daemons
• Usage of the qd.q module is documented in the the tutorial, in +qd/+q/concepts.md and in +qd/+q/jobs.md.
• A sequential run example: SequentialRun.md
• Markdown Cheatsheet for writing documentation
• The code itself (don't be afraid).

Contact

• Anders Jellinggaard: [email protected].