Skip to content

A repository containing a QCoDeS-compatible driver for a labjack

License

Notifications You must be signed in to change notification settings

QCoDeS/labjackdriver

Repository files navigation

labjackdriver

Description

A repo containing a QCoDeS-compatible driver for a labjack.

Installation

Create a conda environment from the environment file in the root folder;

conda env create -f environment.yml

Then activate the environment

conda activate labjackdriver

and install labjackdriver either non-editably

pip install .

or in editable mode

pip install -e .

Usage

Running the tests

If you have gotten labjackdriver from source, you may run the tests locally.

Install labjackdriver along with its test dependencies into your virtual environment by executing the following in the root folder

$ pip install .
$ pip install -r test_requirements.txt

Then run pytest in the tests folder.

Building the documentation

If you have gotten labjackdriver from source, you may build the docs locally.

Install labjackdriver along with its documentation dependencies into your virtual environment by executing the following in the root folder

$ pip install .
$ pip install -r docs_requirements.txt

You also need to install pandoc. If you are using conda, that can be achieved by

$ conda install pandoc

else, see here for pandoc's installation instructions.

Then run make html in the docs folder. The next time you build the documentation, remember to run make clean before you run make html.

About

A repository containing a QCoDeS-compatible driver for a labjack

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages