pymodaq_plugins_mockexamples
This PyMoDAQ plugin adds various Mock instruments to test PyMoDAQ functionalities
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
Move and Grab (extensions/move_and_grab.py): the smallest useful Dashboard extension, to start from when writing yours. It moves an actuator of the Dashboard’s experiment to a target, grabs a detector, shows the data and can save them. It shows how to use the modules_manager, how to wait for the instruments with callbacks instead of blocking the GUI, units on the positions and a clean shutdown. It works with the mock instruments of PyMoDAQ. See “How a Dashboard extension works” in the PyMoDAQ documentation.
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.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pymodaq_plugins_mockexamples-5.3.8.tar.gz | 17.0 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pymodaq_plugins_mockexamples-5.3.8-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 34.3 MB
Release files / pymodaq_plugins_mockexamples-5.3.8.tar.gz
| Download URL | pymodaq_plugins_mockexamples-5.3.8.tar.gz |
|---|---|
| Size | 17.0 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
cb6f3591bfddeb49e88f7e02f6a3a5fe3dc84add03c27c344413c3cf1b54e924
|
|
BLAKE2b-256 checksum How to use checksums |
79bd7d23b6c875773fa33185fa997c608cc7c3f80b20b491fc59844c7f5f8cda
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
Hatch/1.18.1 {"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.8"},"installer":{"name":"hatch","version":"1.18.1"},"openssl_version":"OpenSSL 3.0.13 30 Jan 2024","python":"3.14.8","system":{"name":"Linux","release":"6.17.0-1022-azure"}} HTTPX2/2.13.1
|
Release files / pymodaq_plugins_mockexamples-5.3.8-py3-none-any.whl
| Download URL | pymodaq_plugins_mockexamples-5.3.8-py3-none-any.whl |
|---|---|
| Size | 17.3 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
550ec25740257d09ce062142a36a69348666c088be2d9e323a1ef5e600b6e7ad
|
|
BLAKE2b-256 checksum How to use checksums |
92e54c828323cba7d25760750d91be8fe8eb3fd0e2618be56614fc4d660be150
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
Hatch/1.18.1 {"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.8"},"installer":{"name":"hatch","version":"1.18.1"},"openssl_version":"OpenSSL 3.0.13 30 Jan 2024","python":"3.14.8","system":{"name":"Linux","release":"6.17.0-1022-azure"}} HTTPX2/2.13.1
|
