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

Moved microscoperc.yaml to microscope_settings.yaml

Browse source
This commit is contained in:
Joel Collins 2019-05-20 10:09:01 +01:00
parent 1fe8ea18d8
commit 9fc4dfc628
4 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/source/config.rst
View file

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

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

@ -25,11 +25,11 @@ 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 microscoperc.yaml
Loading plugins with microscope_settings.yaml
--------------------------------------
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 microscoperc.yaml file may look like:
For example, the plugins section of your microscope_settings.yaml file may look like:
.. code-block:: yaml