Metadata-Version: 2.4
Name: pymodaq_plugins_thorlabs
Version: 1.7.1
Summary: Set of PyMoDAQ plugins for instruments from Thorlabs (Kinesis K10CR1 (stepper rotation actuator), Kinesis Flipper, Kinesis KSP100, DCx camera...)
Project-URL: Homepage, https://pymodaq.cnrs.fr
Project-URL: Documentation , https://pymodaq.cnrs.fr
Project-URL: Repository , https://github.com/PyMoDAQ/pymodaq_plugins_thorlabs
Author-email: Sébastien Weber <sebastien.weber@cemes.fr>
Maintainer-email: Sébastien Weber <sebastien.weber@cemes.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: elliptec
Requires-Dist: instrumental-lib
Requires-Dist: nicelib
Requires-Dist: opencv-python
Requires-Dist: pylablib==1.4.1
Requires-Dist: pymodaq-utils
Requires-Dist: pymodaq>=4.4.0
Requires-Dist: pythonnet
Requires-Dist: pywin32
Description-Content-Type: text/x-rst

pymodaq_plugins_thorlabs (Thorlabs Instruments)
###############################################

.. image:: https://img.shields.io/pypi/v/pymodaq_plugins_thorlabs.svg
   :target: https://pypi.org/project/pymodaq_plugins_thorlabs/
   :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_thorlabs/workflows/Upload%20Python%20Package/badge.svg
   :target: https://github.com/PyMoDAQ/pymodaq_plugins_thorlabs
   :alt: Publication Status

Set of PyMoDAQ plugins for instruments from Thorlabs (Kinesis K10CR1 (stepper rotation actuator), Kinesis Flipper,
Kinesis KSP100, Kinesis KPZ101, Camera DCx, Scientific cameras, Powermeters using the TLPM library), Compact CCD Spectrometers


Authors
=======

* Sebastien J. Weber
* David Bresteau (david.bresteau@cea.fr)
* Nicolas Tappy (nicolas.tappy@epfl.ch)
* Romain Geneaux (romain.geneaux@cea.fr)
* Amelie DeShazer (adeshazer@wisc.edu)
* Astha Khandelwal (asthak@iisc.ac.in)
* Daichi Kozawa (kozawa.daichi@nims.go.jp)

Instruments
===========

Below is the list of instruments included in this plugin

Actuators
+++++++++

* **KinesisIntegratedStepper**: Integrated Stepper Motor Kinesis series (tested on K10CR1)
* **Kinesis_Flipper**: Kinesis series Flipper
* **MFF101_pylablib**: Kinesis series Flipper mount (thorlabs MFF101), similar to **Kinesis_FLipper** but using the pylablib control module.
* **PRM1Z8_pylablib**: DC servo motorized 360° rotation mount (Thorlabs PRM1Z8) using the pylablib control module. The Thorlabs APT software should be installed: https://www.thorlabs.com/newgrouppage9.cfm?objectgroup_id=9019.
* **BrushlessDCMotor**: Kinesis control of DC Brushless Motor (tested with the BBD201 controller)
* **Kinesis_KPZ101**: Piezo Electric Stage Kinesis series (KPZ101)


Viewer0D
++++++++

* **Kinesis_KPA101**: Position Sensitive Photodetector Kinesis series (KPA101)
* **TLPMPowermeter**: TLPM dll compatible series (PM101x, PM102x, PM103x, PM100USB, PM16-Series, PM160, PM400, PM100A, PM100D, PM200)

Viewer1D
++++++++
* **CCSXXX**: Compact CCD Spectrometers (CCS100, CCS175, CCS200). Tested with CCS175/M

Viewer2D
++++++++

* **Thorlabs_DCx**: Thorlabs CCD camera. Tested with DCC3240M.
* **Thorlabs_TSI**: sCMOS camera series Zelux, Kiralux, Quantalux.

Installation instructions
=========================

Thorlabs_DCx
++++++++++++
Works with Windows. Precise installation instructions can be found here:
https://instrumental-lib.readthedocs.io/en/stable/uc480-cameras.html and in the plugin file.

Scientific cameras
++++++++++++++++++
Implemented using the pylablib control module.
Required libraries are installed using the free
`ThorCam <https://www.thorlabs.com/software_pages/ViewSoftwarePage.cfm?Code=ThorCam>`__ software.
The plugin assumes Thorcam is installed in default folder
(see `details here <https://pylablib.readthedocs.io/en/stable/devices/Thorlabs_TLCamera.html>`__). Tested on Zelux camera on Windows.