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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pymodaq_plugins_mockexamples-5.0.12.tar.gz (17.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pymodaq_plugins_mockexamples-5.0.12-py3-none-any.whl (17.3 MB view details)

Uploaded Python 3

File details

Details for the file pymodaq_plugins_mockexamples-5.0.12.tar.gz.

File metadata

  • Download URL: pymodaq_plugins_mockexamples-5.0.12.tar.gz
  • Upload date:
  • Size: 17.0 MB
  • Tags: Source
  • Uploaded using 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

File hashes

Hashes for pymodaq_plugins_mockexamples-5.0.12.tar.gz
Algorithm Hash digest
SHA256 4b357f9fb8c55da01273ef322ba5197d9c724fcd31e095c627a9531f1c400cb7
MD5 a69971b8432b14b9bc99bd50d756de1f
BLAKE2b-256 15d23bd26c315627f9d97980d8e01cb45090de7f12f049599efe51d0b611d29c

See more details on using hashes here.

File details

Details for the file pymodaq_plugins_mockexamples-5.0.12-py3-none-any.whl.

File metadata

  • Download URL: pymodaq_plugins_mockexamples-5.0.12-py3-none-any.whl
  • Upload date:
  • Size: 17.3 MB
  • Tags: Python 3
  • Uploaded using 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

File hashes

Hashes for pymodaq_plugins_mockexamples-5.0.12-py3-none-any.whl
Algorithm Hash digest
SHA256 a5882bfcd2fa77cf65bd4b408616db80c2af17d32f4d7343e80042eabcb69da2
MD5 5e4c97780a157af8cc3f2113ec2d0800
BLAKE2b-256 ca5d0aa96b69afc3f3e9c7e0f135fa2a9278b1524ed87ce9a83c6b9876a6c57e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page