diff --git a/docs/source/adding_devices.rst b/docs/source/adding_devices.rst index f56fae8c..31ed0edf 100644 --- a/docs/source/adding_devices.rst +++ b/docs/source/adding_devices.rst @@ -37,7 +37,7 @@ There are currently two supported file organization styles for a labscript-devic The old style has the `labscript_device`, `BLACS_tab`, `BLACS_worker`, and `runviewer_parser` all in the same file, which typically has the same name as the `labscript_device` class name. -The new style allows for arbitrary code organization, but typically has a folder named after the `labscript_device` with each device component in a different file (ie `labscript_devices.py`, `BLACS_workers.py`, etc). With this style, the folder requires an `__init__.py` file (which can be empty) as well as a `register_classes.py` file. This file imports :ref:`` via +The new style allows for arbitrary code organization, but typically has a folder named after the `labscript_device` with each device component in a different file (ie `labscript_devices.py`, `BLACS_workers.py`, etc). With this style, the folder requires an `__init__.py` file (which can be empty) as well as a `register_classes.py` file. This file imports :obj:`` via .. code-block:: python diff --git a/docs/source/conf.py b/docs/source/conf.py index 8f86f899..5e4d5b26 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -172,6 +172,13 @@ else: todo_include_todos = True +# -- Options for PDF output -------------------------------------------------- + +latex_elements = { + # make entire document landscape + 'geometry': '\\usepackage[landscape]{geometry}', +} + # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for diff --git a/docs/source/devices/ni_daqs.rst b/docs/source/devices/ni_daqs.rst index 0353e05c..d5600996 100644 --- a/docs/source/devices/ni_daqs.rst +++ b/docs/source/devices/ni_daqs.rst @@ -51,7 +51,12 @@ The current list of pre-subclassed devices is: Usage ~~~~~ -NI Multifunction DAQs generally provide hardware channels for the :ref:`StaticAnalogOut `, :ref:`StaticDigitalOut `, :ref:`AnalogOut `, :ref:`DigitalOut `, and :ref:`AnalogIn ` labscript quantities for use in experiments. Exact numbers of channels, performance, and configuration depend on the model of DAQ used. +NI Multifunction DAQs generally provide hardware channels for +:class:`StaticAnalogOut `, +:class:`StaticDigitalOut `, +:class:`AnalogOut `, +:class:`DigitalOut `, +and :class:`AnalogIn ` labscript quantities for use in experiments. Exact numbers of channels, performance, and configuration depend on the model of DAQ used. .. code-block:: python @@ -73,7 +78,7 @@ NI Multifunction DAQs generally provide hardware channels for the :ref:`StaticAn AnalogOut('daq_ao0',daq,'ao0') AnalogIn('daq_ai1',daq,'ai1') -NI DAQs are also used within labscript to provide a :ref:`WaitMonitor `. When configured, the `WaitMonitor` allows for arbitrary-length pauses in experiment execution, waiting for some trigger to restart. The monitor provides a measurement of the duration of the wait for use in interpreting the resulting data from the experiment. +NI DAQs are also used within labscript to provide a :class:`WaitMonitor `. When configured, the `WaitMonitor` allows for arbitrary-length pauses in experiment execution, waiting for some trigger to restart. The monitor provides a measurement of the duration of the wait for use in interpreting the resulting data from the experiment. Configuration uses three digital I/O connections on the DAQ: diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst index 052c4cf9..c8932647 100644 --- a/docs/source/introduction.rst +++ b/docs/source/introduction.rst @@ -5,15 +5,15 @@ The **labscript_devices** module contains the low-level hardware interfacing cod Each "device" is made up of four classes that handle the various tasks. -* `labscript_device` (derives from :doc:`labscript.Device `) +* `labscript_device` (derives from :obj:`Device `) - Defines the interface between the **labscript** API and generates hardware instructions that can be saved to the shot h5 file. -* `BLACS_tab` (derives from :doc:`blacs.device_base_class.DeviceTab `) +* `BLACS_tab` (derives from :obj:`DeviceTab `) - Defines the graphical tab that is present in the **BLACS** GUI. This tab provides graphical widgets for controlling hardware outputs and visualizing hardware inputs. -* `BLACS_worker` (derives from :doc:`blacs.tab_base_classes.Worker `) +* `BLACS_worker` (derives from :class:`Worker `) - Defines the software control interface to the hardware. The `BLACS_tab` spawns a process that uses this class to send and receive commands with the hardware. @@ -21,4 +21,4 @@ Each "device" is made up of four classes that handle the various tasks. - Defines a software interface that interprets hardware instructions in a shot h5 file and displays them in the :doc:`runviewer ` GUI. -The **labscript_suite** provides an extensive :doc:`list of device classes ` for commercially available hardware. Furthermore, it is simple to add local :doc:`user devices ` to control instruments not already within the labscript-suite. \ No newline at end of file +The **labscript_suite** provides an extensive :doc:`list of device classes ` for commercially available hardware. Furthermore, it is simple to add local :doc:`user devices ` to control instruments not already within the labscript-suite. diff --git a/labscript_devices/LightCrafterDMD.py b/labscript_devices/LightCrafterDMD.py index e8e0ca59..3f40ffdb 100644 --- a/labscript_devices/LightCrafterDMD.py +++ b/labscript_devices/LightCrafterDMD.py @@ -61,6 +61,12 @@ class ImageSet(Output): height = HEIGHT # Set default value to be a black image. Here's a raw BMP! default_value = BLANK_BMP + """bytes: A black image. + + Raw bitmap data hidden from docs. + + :meta hide-value: + """ def __init__(self, name, parent_device, connection = 'Mirror'): Output.__init__(self, name, parent_device, connection)