Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 21 additions & 68 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,88 +1,41 @@
pymodaq_plugins_template
########################
pymodaq_plugins_princeton_instruments
#####################################

.. the following must be adapted to your developed package, links to pypi, github description...

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

.. image:: https://github.com/PyMoDAQ/pymodaq_plugins_template/actions/workflows/Test.yml/badge.svg
:target: https://github.com/PyMoDAQ/pymodaq_plugins_template/actions/workflows/Test.yml


Use this template to create a repository on your account and start the development of your own PyMoDAQ plugin!

.. image:: https://github.com/PyMoDAQ/pymodaq_plugins_princeton_instruments/actions/workflows/Test.yml/badge.svg
:target: https://github.com/PyMoDAQ/pymodaq_plugins_princeton_instruments/actions/workflows/Test.yml

Authors
=======

* First Author (myemail@xxx.org)
* Other author (myotheremail@xxx.org)

.. if needed use this field

Contributors
============

* First Contributor
* Other Contributors

.. if needed use this field

Depending on the plugin type, delete/complete the fields below

* Adrien Teurtrie (adrien.teurtrie@cemes.fr)

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

Below is the list of instruments included in this plugin

Actuators
+++++++++

* **yyy**: control of yyy actuators
* **xxx**: control of xxx actuators

Viewer0D
++++++++

* **yyy**: control of yyy 0D detector
* **xxx**: control of xxx 0D detector

Viewer1D
++++++++

* **yyy**: control of yyy 1D detector
* **xxx**: control of xxx 1D detector


Viewer2D
++++++++

* **yyy**: control of yyy 2D detector
* **xxx**: control of xxx 2D detector


PID Models
==========


Extensions
==========

* **Fergie**: control of the Fergie spectrometer and its camera. It works through communication with the lightfield software.
* **Picam**: control of 2D detectors that can be controlled with the Picam.dll of Teledyne.

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

* PyMoDAQ’s version.
* Operating system’s version.
* What manufacturer’s drivers should be installed to make this plugin run?
* PyMoDAQ 5.1.x
* Windows 11 64 bits
* For the Fergie, installing the LightField software of Teledyne is required : https://www.teledynevisionsolutions.com/en-au/products/lightfield/?model=LF&vertical=tvs-princeton-instruments&segment=tvs (tested with an outdated licence.)
* For the Picam, installing the Picam software of Teledyne is required : https://www.teledynevisionsolutions.com/en-au/products/picam-sdk-amp-driver/?model=PICAM64&vertical=tvs-princeton-instruments&segment=tvs

Work to be done
===============

* Create a DAQMove to control the wavelength of the Fergie.
* Test multiple Picam cameras working together.
* Improve the code and documentation of the Fergie DAQ2D_Viewer
* Implement ROIs for the Picam
8 changes: 3 additions & 5 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,14 @@ description = 'some word about your plugin'
dependencies = [
"pymodaq>=5.0.0",
"pythonnet",
#todo: list here all dependencies your package may have
"pylablib"
]

authors = [
{name = "Name Surname", email = "myname@test.fr"},
#todo: list here all authors of your plugin
{name = "Adrien Teurtrie", email = "adrien.teurtrie@cemes.fr"},
]
maintainers = [
{name = "Name Surname", email = "myname@test.fr"},
#todo: list here all maintainers of your plugin
{name = "Adrien Teurtrie", email = "adrien.teurtrie@cemes.fr"},
]

# nottodo: leave everything below as is!
Expand Down
Loading