Skip to content

Commit

Permalink
add Ivo as corresponding author, minor typography
Browse files Browse the repository at this point in the history
  • Loading branch information
Jeroen Doornbos committed Oct 16, 2024
1 parent 4ee2f6a commit 04fc4ff
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 9 deletions.
5 changes: 3 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,12 @@
\author[1]{Daniël~W.~S.~Cox}
\author[1]{Tom~Knop}
\author[1,3]{Harish~Sasikumar}
\author[1]{Ivo~M.~Vellekoop}
\author[1*]{Ivo~M.~Vellekoop}
\affil[1]{University of Twente, Biomedical Photonic Imaging, TechMed Institute, P. O. Box 217,
7500 AE Enschede, The Netherlands}
\affil[2]{Currently at: The Netherlands Cancer Institute, Division of Molecular Pathology, 1066 CX Amsterdam, The Netherlands}
\affil[3]{Imec (Netherlands), Holst Centre (HTC-31), 5656 AE, Eindhoven, The Netherlands}
\affil[*]{Corresponding author: [email protected]}
\publishers{%
\normalfont\normalsize%
\parbox{0.8\linewidth}{%
Expand Down Expand Up @@ -121,7 +122,7 @@
napoleon_use_rtype = False
napoleon_use_param = True
typehints_document_rtype = False
latex_engine = "xelatex"
latex_engine = "pdflatex"
html_theme = "sphinx_rtd_theme"
add_module_names = False
autodoc_preserve_defaults = True
Expand Down
13 changes: 8 additions & 5 deletions docs/source/core.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,11 +79,6 @@ The program does not wait for the data to become available and can directly proc

Note that, except for this asynchronous mechanism for fetching and processing data, OpenWFS is not designed to be thread-safe, and the user is responsible for guaranteeing that devices are only accessed from a single thread at a time.

.. _hellowfsdiagram:
.. figure:: hellowfsflowchart.png
:align: center

Flowchart of the ``hello_wfs.py`` example.

Processors
------------
Expand Down Expand Up @@ -111,6 +106,8 @@ Actuators

Actuators are devices that *move* things in the setup. This can be literal, such as moving a translation stage, or a virtual movement, like an SLM that takes time to switch to a different phase pattern. All actuators are derived from the common :class:`.Actuator` base class. Actuators have no additional methods or properties other than those in the :class:`.Device` base class. A list of actuators currently supported by OpenWFS can be found in the table below.



.. list-table::
:widths: 27 73

Expand All @@ -121,6 +118,12 @@ Actuators are devices that *move* things in the setup. This can be literal, such
* - simulation.XYStage
- Simulates a translation stage, used in :class:`~Microscope`.

.. _hellowfsdiagram:
.. figure:: hellowfsflowchart.png
:align: center

Flowchart of the ``hello_wfs.py`` example.


Algorithms
------------
Expand Down
2 changes: 0 additions & 2 deletions docs/source/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ By default, this only installs the dependencies for the basic OpenWFS package. T

The examples are located in the ``examples`` directory. Note that a lot of functionality is also demonstrated in the automatic tests located in the ``tests`` directory. As an alternative to downloading the source code, the samples can also be copied directly from the example gallery on the documentation website :cite:`readthedocsOpenWFS`.

.

Building the documentation
--------------------------------------------------

Expand Down

0 comments on commit 04fc4ff

Please sign in to comment.