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

Converted all configs to JSON

Browse source
This commit is contained in:
Joel Collins 2019-11-12 14:36:39 +00:00
parent 94a8774ceb
commit b81cfaf9e7
13 changed files with 175 additions and 218 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/source/config.rst
View file

@ -11,7 +11,7 @@ Microscope RC file
------------------
Microscope configuration is made persistent via a microscope runtime-config (RC) file. By default, this
file exists at ``~/.openflexure/microscope_settings.yaml``, and contains basic parameters to set up the microscope.
file exists at ``~/.openflexure/microscope_settings.json``, and contains basic parameters to set up the microscope.
Additionally, by default, configurations for specific pieces of hardware (i.e. the stage and camera) are located
in separate "auxillary" config files, and are linked together by adding the config file's path to your main

15
docs/source/plugins/introduction.rst
View file

@ -25,17 +25,18 @@ Generally, for adding anything other than very simple functionality, plugins sho
The main restriction is that the plugin package must be importable using an absolute import from within the Python environment being used to load your microscope.
Loading plugins with microscope_settings.yaml
Loading plugins with microscope_settings.json
---------------------------------------------
Both types of plugin are loaded by specifying the plugin class in your :ref:`MicroscopeRC`. In the case of a single-file plugin, specify the path to the plugin file, followed by the name of your :py:class:`openflexure_microscope.plugins.MicroscopePlugin` child class, separated by a colon. For packaged plugins, specify the absolute module name in place of the path.
For example, the plugins section of your microscope_settings.yaml file may look like:
For example, the plugins section of your microscope_settings.json file may look like:
.. code-block:: yaml
.. code-block:: json
...
plugins:
- openflexure_microscope.plugins.default:Plugin
- ~/my_plugins/my_plugin_file.py:MyPluginClass
- my_openflexure_plugins.microscope.mypluginpackage:MyPluginClass
"plugins": [
"openflexure_microscope.plugins.default:Plugin",
"~/my_plugins/my_plugin_file.py:MyPluginClass",
"my_openflexure_plugins.microscope.mypluginpackage:MyPluginClass"
]
...