From 8284666251cd839ef68aa686814a075377b3c6d9 Mon Sep 17 00:00:00 2001 From: Claude Date: Wed, 4 Nov 2026 16:46:52 +0000 Subject: [PATCH] README: keep Authors and Instruments first, the other sections after The plugin manager reads the README in the order Authors, Instruments. Co-Authored-By: Claude Sonnet 5.5 Claude-Session: https://claude.ai/code/session_01Tdiso1u1ZhikSutj2Qs5Cg --- README.rst | 84 +++++++++++++++++++++++++++--------------------------- 1 file changed, 42 insertions(+), 42 deletions(-) diff --git a/README.rst b/README.rst index 35075e1..42eeb93 100644 --- a/README.rst +++ b/README.rst @@ -17,48 +17,6 @@ Plugins devoted to National Instruments signal acquisition and generation, using configured from the settings tree), plugins for specific uses (photon counting, piezo scanner control, analog input acquisition), and the ``DAQmx`` wrapper object to build your own plugin on. -Difference with the 5.3.x branch -================================ - -The repository has two lines of plugins, which use two different Python interfaces to the same NI-DAQmx driver. They -do not share their instrument plugins (``DAQmx_...`` here, ``NIDAQmx`` there). - -.. list-table:: - :header-rows: 1 - :widths: 20 40 40 - - * - - - ``pydaqmx`` branch (this one) - - ``5.3.x`` branch - * - Python interface - - `PyDAQmx `_ (``DAQmx`` object in ``hardware/national_instruments/daqmx.py``) - - `nidaqmx `_, the package of National Instruments (``NIDAQmx`` - object in ``daqmxni.py``) - * - Instruments - - generic ``DAQmx`` actuator and viewers (0D, 1D), ``DAQmxAI``, ``DAQmxDualAI``, ``DAQmx_PLcounter``, - ``DAQmx_ScannerControl``, ``DAQmx_MultipleScannerControl`` - - ``NIDAQmx`` actuator, 0D viewer and 1D viewer - * - Use - - specific tasks (photon counting, piezo scanner control, analog input) and a base to write your own plugin - - measurement of voltage, current or temperature with a general viewer, whose channels can be loaded from a - configuration file of the user (``config_daqmx.toml``) and saved from the interface - * - State - - the ``PyDAQmx`` based plugins, kept as they are - - the ``NIDAQmx`` viewers were tested with a cDAQ-9174 and a USB-6341 (modules NI-9205, NI-9211, NI-9217); the - ``NIDAQmx`` actuator is not finished yet (its movements still raise ``NotImplementedError``) - -The ``5.3.x`` branch still contains the ``PyDAQmx`` based ``DAQmx`` object and its user guides, but not the instrument plugins -of this branch. - -Requirements -============ - -* PyMoDAQ >= 5.3.7 -* the NI-DAQmx driver of National Instruments, installed on the computer connected to the device (use NI MAX to test - your hardware). Where ``PyDAQmx`` cannot find the driver, the modules of this plugin cannot be imported and PyMoDAQ - skips them. -* the ``pydaqmx`` Python package, installed with the plugin. - Authors ======= @@ -102,3 +60,45 @@ Documentation Refer to the `documentation `_ to use this plugin or discover its functionalities (user guide for the photon counter and the scanner control, and how to create your own module with the ``DAQmx`` object). + +Difference with the 5.3.x branch +================================ + +The repository has two lines of plugins, which use two different Python interfaces to the same NI-DAQmx driver. They +do not share their instrument plugins (``DAQmx_...`` here, ``NIDAQmx`` there). + +.. list-table:: + :header-rows: 1 + :widths: 20 40 40 + + * - + - ``pydaqmx`` branch (this one) + - ``5.3.x`` branch + * - Python interface + - `PyDAQmx `_ (``DAQmx`` object in ``hardware/national_instruments/daqmx.py``) + - `nidaqmx `_, the package of National Instruments (``NIDAQmx`` + object in ``daqmxni.py``) + * - Instruments + - generic ``DAQmx`` actuator and viewers (0D, 1D), ``DAQmxAI``, ``DAQmxDualAI``, ``DAQmx_PLcounter``, + ``DAQmx_ScannerControl``, ``DAQmx_MultipleScannerControl`` + - ``NIDAQmx`` actuator, 0D viewer and 1D viewer + * - Use + - specific tasks (photon counting, piezo scanner control, analog input) and a base to write your own plugin + - measurement of voltage, current or temperature with a general viewer, whose channels can be loaded from a + configuration file of the user (``config_daqmx.toml``) and saved from the interface + * - State + - the ``PyDAQmx`` based plugins, kept as they are + - the ``NIDAQmx`` viewers were tested with a cDAQ-9174 and a USB-6341 (modules NI-9205, NI-9211, NI-9217); the + ``NIDAQmx`` actuator is not finished yet (its movements still raise ``NotImplementedError``) + +The ``5.3.x`` branch still contains the ``PyDAQmx`` based ``DAQmx`` object and its user guides, but not the instrument plugins +of this branch. + +Requirements +============ + +* PyMoDAQ >= 5.3.7 +* the NI-DAQmx driver of National Instruments, installed on the computer connected to the device (use NI MAX to test + your hardware). Where ``PyDAQmx`` cannot find the driver, the modules of this plugin cannot be imported and PyMoDAQ + skips them. +* the ``pydaqmx`` Python package, installed with the plugin.