Skip to main content
Latest Version Documentation Status Publication Status https://github.com/PyMoDAQ/pymodaq_plugins_mockexamples/actions/workflows/Test.yml/badge.svg

This PyMoDAQ plugin adds various Mock instruments to test PyMoDAQ functionalities

Authors

Instruments

Below is the list of instruments included in this plugin

Actuators

  • MockCamera: set of X, Y or theta actuators moving a light image on the corresponding camera instrument. To be used with the 2D detector MockCamera. An experiment file called beam_steering.xml is available in the resources folder to be copied in the .pymodaq/experiments folder to orchestrate such a simulated beam steering experiment.

  • MockNamedAxes: Show examples of multi axis actuator controller specifying both a name and an integer ID

  • MockRandom actuator to be used with the corresponding 0D detector. If they share the same ID in the preset then this actuator can be moved in the [0-20] range (even randomly) to retrieve a noisy gaussian

  • MockTauMulti: controller with multiple axes and showing how to add a characteristic time (to mimic real instruments)

  • MockHeater: actuator simulating the heating of something (in Watt). To be used with the mockHeater 0D detector. An experiment file called Heater.xml is available in the resources folder to be copied in the .pymodaq/experiments folder to orchestrate such a simulated experiment. Can be used to test the PID extension.

  • MockTempController simulation of a temperature controller with inner PID stabilization loop possibilities or manual power control. Has two axes: Temperature for the PID setpoint (if PID enabled) and Power for manual power controller if PID disabled. An experiment file called TempController.xml is available in the resources folder to be copied in the .pymodaq/experiments folder to orchestrate such a simulated experiment.

Viewer0D

  • MockAdaptive: to be used to show how a detector can be used for adaptive samplking (not working yet with PyMoDAQ4)

  • MockRandom: generate a value of a noisy gaussian given the current value of the underlying mock controller. To be used with the MockRandom actuator. If they share the same ID in the preset then this actuator can be moved in the [0-20] range (even randomly) to retrieve a noisy gaussian

  • MockHeater: detector simulating the temperature measurement of something. To be used with the mockHeater actuator

  • MockTempController simulation of a temperature controller (should be slave of the MockTempController master actuator). Probe both the instantaneous temperature and the current applied power

Viewer1D

  • MockSpectro: mimic data one coulf obtain from a spectrometer. Specific methods are also added to seemlessly use this detector with the Spectrometer extension (not yet working with PyMoDAQ4)

  • MockRandom: Generate a noisy Gaussian with a spread axis (to illustrate the sorting button action of the Viewer1D data viewer

  • Pinem: Generate Photon-Induced Near-field Electron Microscopy spectra. It is Electron energy loss spectroscopy from the interaction of a near-field (could be induced by a laser on a sample) and probed by the electronic beam. The coupling between the near-field and the electronic beam can be tuned using various parameters (g1, g2, theta)…

Viewer2D

  • MockCamera: if connected with a preset with the MockCamera actuator (or a few of them, X, Y and thera), then the image displayed on screen is moved or rotated accordingly to the actuators value. Perfect for a beamsteering example

  • RoiStuff: example of ROI exporting into the instrument plugin. Not yet working, planned to be ok for the future >= 4.2.* releases.

ViewerND

  • MockEvents: Simulate the acquisition of photons received on a timepix camera (position and time of arrival of each photon)

PID Models

Extensions

Installation instructions

  • PyMoDAQ >= 5 (except for some of them, specified in this README)

  • nothing in particular to be installed, they are all virtual instruments

Metadata

Release files for pymodaq_plugins_mockexamples 5.3.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pymodaq_plugins_mockexamples 5.3.5
File Size Uploaded
pymodaq_plugins_mockexamples-5.3.5.tar.gz 17.0 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for pymodaq_plugins_mockexamples 5.3.5
File Interpreter ABI Platform
pymodaq_plugins_mockexamples-5.3.5-py3-none-any.whl Python 3 none any Details

Total release size: 34.3 MB

Release files / pymodaq_plugins_mockexamples-5.3.5.tar.gz

Download URL pymodaq_plugins_mockexamples-5.3.5.tar.gz
Size 17.0 MB
Tags Source
SHA-256 checksum
How to use checksums
f74a50673b6ff8d11cf6c092d4bfab4854fa5f368dd7911fe5a2981532b3030d
BLAKE2b-256 checksum
How to use checksums
e307380d68d2c69202a8cc52985905e0af05636bedf360b26cde5215f87a6c27
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Hatch/1.18.0 {"ci":true,"cpu":"x86_64","distro":{"id":"noble","libc":{"lib":"glibc","version":"2.39"},"name":"Ubuntu","version":"24.04"},"implementation":{"name":"CPython","version":"3.14.7"},"installer":{"name":"hatch","version":"1.18.0"},"openssl_version":"OpenSSL 3.0.13 30 Jan 2024","python":"3.14.7","system":{"name":"Linux","release":"6.17.0-1022-azure"}} HTTPX2/2.12.0

Release files / pymodaq_plugins_mockexamples-5.3.5-py3-none-any.whl

Download URL pymodaq_plugins_mockexamples-5.3.5-py3-none-any.whl
Size 17.3 MB
Tags Python 3
SHA-256 checksum
How to use checksums
2e1af538f9c34f39441a2a10bf9dacba0b3abbaa5313b330217b5d3397731a6c
BLAKE2b-256 checksum
How to use checksums
6efd26f09187bb4b82365bccd12bfaf4d5726d23cdd4dc48eae52b557b8e47d7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Hatch/1.18.0 {"ci":true,"cpu":"x86_64","distro":{"id":"noble","libc":{"lib":"glibc","version":"2.39"},"name":"Ubuntu","version":"24.04"},"implementation":{"name":"CPython","version":"3.14.7"},"installer":{"name":"hatch","version":"1.18.0"},"openssl_version":"OpenSSL 3.0.13 30 Jan 2024","python":"3.14.7","system":{"name":"Linux","release":"6.17.0-1022-azure"}} HTTPX2/2.12.0

Release history Release notifications | RSS feed

This release

5.3.5 This release

2 release files

5.3.4

2 release files

5.3.3

2 release files

5.3.2

2 release files

5.3.1

2 release files

5.3.0

2 release files

5.0.12

2 release files

5.0.11

2 release files

5.0.10

2 release files

5.0.9

2 release files

5.0.8

2 release files

5.0.7

2 release files

5.0.6

2 release files

5.0.5

2 release files

5.0.4

2 release files

5.0.3

2 release files

5.0.2

2 release files

5.0.1

2 release files

5.0.0

2 release files

4.0.3

2 release files

4.0.2

2 release files

4.0.1

2 release files

1.0.8

2 release files

1.0.7

2 release files

1.0.6

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.1

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.1

2 release files

0.1.0

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page