rahix/openflexure-microscope-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add docstrings to all public package

Browse source
This commit is contained in:
Julian Stirling 2025-07-10 15:29:10 +01:00
parent 14359e73bb
commit 864ca91e5c
7 changed files with 46 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

17
src/openflexure_microscope_server/__init__.py
View file

@ -0,0 +1,17 @@
"""The OpenFlexure Microscope Server Package.
The OpenFlexure Microscope Server is a LabThings-FastAPI server. All hardware
interfaces, and almost all functionality exposed over HTTP is done using ``Things``.
On the microscope the server is started by systemd. It can be controlled using commands
such as ``ofm restart``, ``ofm start``, and ``ofm stop``.
The server can also be run in simulation mode from the terminal. In the root directory
of the repository the server can be started with run:
.. code-block:: bash
openflexure-microscope-server --fallback -c ./ofm_config_simulation.json
"""