pydevice chapter

IvoVellekoop · Oct 4, 2024 · e2d6adf · e2d6adf
1 parent 6cbf485
commit e2d6adf
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 0 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -10,5 +10,6 @@ OpenWFS - a library for conducting and simulating wavefront shaping experiments
     slms
     simulations
     development
+    pydevice
     api
     auto_examples/index
diff --git a/docs/source/index_latex.rst b/docs/source/index_latex.rst
@@ -9,6 +9,7 @@ OpenWFS - a library for conducting and simulating wavefront shaping experiments
     core
     slms
     simulations
+    pydevice
     development
     conclusion
 

diff --git a/docs/source/pydevice.rst b/docs/source/pydevice.rst
@@ -0,0 +1,6 @@
+.. _section-pydevice:
+
+OpenWFS in PyDevice
+==============================================
+
+To smoothly enable end-user interaction with wavefront shaping algorithms, the Micro-Manager device adapter PyDevice was developed :cite:`MMpydevice`. A more detailed description can be found in the mmCoreAndDevices source tree :cite:`mmCoreAndDevices`. In essence, PyDevice is a c++ based adapter that imports objects from a Python script and integrates them in Micro-Manager as devices, e.g. a camera or stage. OpenWFS was written in compliance with the templates required for PyDevice, which means OpenWFS cameras, scanners and algorithms can be loaded into Micro-Manager as devices. Examples of this are found in the example gallery :cite:`ExampleGallery`.