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
9 changes: 8 additions & 1 deletion docs/AcquireBasicUsage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,10 @@ Multiple camera support

PYMEAcquire has some basic support for multiple cameras. If multiple cameras are
defined in the initialisation file, a control will be shown permitting switching
between the cameras.
between the cameras. Additionally, multiple instances of PYMEAcquire can be run
simultaneously, each with a different camera selected. Server backends (action
queues, or the full acquire server) can then be used to coordinate multi-
camera acquisition protocols.

Acquiring data
==============
Expand Down Expand Up @@ -86,3 +89,7 @@ sequence (by clicking on **Series**), or one in which the focus is stepped at re
intervals (**Z-Series**). The Z-Series uses the z-stepping regime defined using the
Z-stack control.

Changing the Graphical User Interface (GUI)
===========================================
The default GUI for PYMEAcquire is based on the WX framework. We are additionally
developing a web GUI. Use of this is described in :ref:`PYMEAcquire Web GUI <PYMEAcquireWebGUI>`.
41 changes: 41 additions & 0 deletions docs/PYMEAcquireWebGUI.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
Using the PYMEAcquire Web Interface
***********************************

.. note::
This interface is still under development and likely buggy!
Please report any issues you encounter, and feel free to
get involved in developing this feature.

Many components of PYME have a server backend to support flexible task
and data distribution, as well as enable analysis-based feedback to
control microscope acquisition.

The PYMEAcquire server enables control of the microscope and acquisition
using a web interface. This is an alternative user interface to the default
WX-based PYMEAcquire.

Setup
=====
The PYMEAcquire server has several dependencies which may not have been
installed with PYME. These can be installed using conda (prefered) or pip.
You will likely need to install pyjwt, for example:
`conda install pyjwt`

Running
=======
To run the PYMEAcquire server, open your terminal, activate the appropriate
environment, and run `python -m PYME.Acquire.acquire_server`. By default,
this will open using simulated hardware. To change the initialization script,
use add `-i <path/to/your/init_script.py>` to the command.

The server will by default open a new browser tab (or window) and navigate to the
web interface.

.. figure:: images/PYMEAcquire_webui_acq.png
:name: fig_webui

The web interface for PYMEAcquire. The left panel includes display options,
camera, laser, and positioning settings, as well as the acquisition control.
Tabs located at the bottom of the screen allow display of the scope state,
and more acquisition settings, including selection of acquisition protocols.

Binary file added docs/images/PYMEAcquire_webui_acq.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.