Skip to content
Merged
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
74 changes: 12 additions & 62 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,86 +3,36 @@ pymodaq_plugins_template

.. 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://github.com/PyMoDAQ/pymodaq_plugins_asi/workflows/Upload%20Python%20Package/badge.svg
:target: https://github.com/PyMoDAQ/pymodaq_plugins_asi
:alt: Publication Status

.. image:: https://readthedocs.org/projects/pymodaq/badge/?version=latest
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can leave the stuff for pymodaq

:target: https://pymodaq.readthedocs.io/en/stable/?badge=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
: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_asi/actions/workflows/Test.yml/badge.svg
:target: https://github.com/PyMoDAQ/pymodaq_plugins_asi/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

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

The Cheetah3 of Amsterdam Scientific Instruments can be interfaced using this plugin.

Viewer2D
++++++++

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


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


Extensions
==========

* **DAQ_2DViewer_Cheetah3**: control of the Cheetah3 2D detector

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

* PyMoDAQ’s version.
* Operating system’s version.
* What manufacturer’s drivers should be installed to make this plugin run?
* PyMoDAQ’s version : 5.0.18
* Operating system’s version : Windows 11
* Serval ASI's server dedicated to the Cheetah3 should be installed (3.3.0 tested). The communication with Serval is done through http.
11 changes: 5 additions & 6 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,19 @@ scanners = false # true if plugin contains custom scan layout (daq_scan extensi
package-url = 'https://github.com/PyMoDAQ/pymodaq_plugins_asi' #todo modify url by your plugin url

[project]
name = "pymodaq_plugins_asi" #todo modify template by your plugin short name
description = 'some word about your plugin'
name = "pymodaq_plugins_asi"
description = 'Pymodaq plugin for controlling Amsterdam Scientific Instruments hardware.'
dependencies = [
"pymodaq>=5.0.0",
#todo: list here all dependencies your package may have
requests,
pillow
]

authors = [
{name = "Teurtrie Adrien", email = "adrien.teurtrie@cemes.fr"},
#todo: list here all authors of your plugin
]
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
Loading