Mesoscopy is a graphical user interface to run experiments in mesoscopic physics. It runs with QCoDeS as a backend. To install and learn how to use, read the quick overview.
- Set up sweeps of one or more parameters (
LinSweep,LogSweep,TogetherSweep), with live plots of the data as it is acquired. - Safe limits and maximum ramp rates for every parameter, and a safe shutdown when you stop or close the program.
- A queue of measurements, waits and series, resumable after a crash.
- A monitor with alarms and a persistent log, and an explorer of the runs of your databases.
- All data goes to standard QCoDeS databases.
Refer to our documentation for installation.
Read it here.
Documentation is built on every push, and deployed on every successful build of main.
We use sphinx for the documentation. To build the documentation locally, make sure that you have the extra dependencies required:
pip install -r docs_requirements.txtThe screenshots of the documentation are made from the program itself (the program must be installed). Go to the directory
docs and type:
make screenshots
make htmlmake screenshots takes about five minutes; it is done again by the workflow on every build. The pages are generated in
docs/_build/html.
As mesoscoPy is still a project in its infancy, we have no strict rules for contribution. However, please make sure you test your code before pushing to the main branch.
The tests run without a screen, on simulated instruments:
pip install ".[test]"
pytestThey also run on every push (.github/workflows/tests.yml).
See License.