Metadata-Version: 2.4
Name: pymodaq_plugins_newport
Version: 5.0.1
Summary: Set of PyMoDAQ plugins for instruments from Newport (Conex, ESP100, SMC100, AG-CU8, ...)
Project-URL: Homepage, https://pymodaq.cnrs.fr
Project-URL: Documentation , https://pymodaq.cnrs.fr
Project-URL: Repository , https://github.com/PyMoDAQ/pymodaq_plugins_newport
Author-email: "Weber J. Sebastien" <sebastien.weber@cnrs.fr>
Maintainer-email: "Weber J. Sebastien" <sebastien.weber@cnrs.fr>
License: The MIT License (MIT)
        
        Copyright (c) 2021 Sebastien Weber <sebastien.weber@cemes.fr>
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in
        all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
        THE SOFTWARE.
License-File: LICENSE
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering :: Human Machine Interfaces
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: User Interfaces
Requires-Python: >=3.8
Requires-Dist: pylablib
Requires-Dist: pymodaq>=5.0.0
Requires-Dist: pythonnet
Requires-Dist: pyvisa
Requires-Dist: pyvisa-py
Description-Content-Type: text/x-rst

pymodaq_plugins_newport (Newport Instruments)
#############################################

.. image:: https://img.shields.io/pypi/v/pymodaq_plugins_newport.svg
   :target: https://pypi.org/project/pymodaq_plugins_newport/
   :alt: Latest Version

.. image:: https://readthedocs.org/projects/pymodaq/badge/?version=latest
   :target: https://pymodaq.readthedocs.io/en/stable/?badge=latest
   :alt: Documentation Status

.. image:: https://github.com/PyMoDAQ/pymodaq_plugins_newport/workflows/Upload%20Python%20Package/badge.svg
    :target: https://github.com/PyMoDAQ/pymodaq_plugins_newport

PyMoDAQ plugin for instruments from Newport (Conex, ESP100, SMC100, AG-CU8...)


Authors
=======

* Sebastien J. Weber
* David Bresteau (david.bresteau@cea.fr)
* Sébastien Quistrebert (sebastien.quistrebert@ens-paris-saclay.fr)
* Bastien Bégon (bastien.begon@crpp.cnrs.fr)
* Elias Sfeir
* Aurore Finco (aurore.finco@umontpellier.fr)

Instruments
===========
Below is the list of instruments included in this plugin

Actuators
+++++++++

* **Conex**: Piezo actuators from the CONEX-AGAP series"
* **Newport_ESP100**: ESP100 motion controllers
* **AgilisSerial**: for controllers AG-UC8 and AG-UC2 tested with motorized mounts AG-M100N (no encoder)
* **XPS-Q8**: 8-axis Universal Motion Controller/Driver, ethernet
* **SMC100**: Single axis motion controller
* **Picomotor8742**: 4-axis open-loop motion controller

Installation notes
==================

AGILIS AG-CU8
+++++++++++++

Install Newport AG-UC2-UC8 applet available here: https://www.newport.com/p/AG-UC8 and test that
you can communicate with this firmware.

This plugin use the included AgilisSerial wrapper communicating with the device using serial comunication
and the pyvisa package

$ python setup.py install

This last command should be executed in the python environment where you installed pymodaq.

Tested on Windows10 with pymodaq >= 3.3.0.

XPS-Q8
++++++

tested on Windows 11 with pymodaq >= 4.1.0.

SMC100
++++++

Tested with SMC100PP (stepper motor) controller using USB/RS232 connection and URS150 motorized rotation stage.
Installing `Newport SMC100 software <https://www.newport.com/f/smc100-single-axis-dc-or-stepper-motion-controller>`_ should provide all necessary drivers.

Operating System: Windows 11

PyMoDAQ version: 4.3.0 running in a conda environment with Python 3.11.9

Picomotor 8742
++++++++++++++

This plugin uses the pylablib driver.
Tested on Windows 10 with pymodaq >= 4.4.0 in a conda environment with Python 3.8


