From bc3b702e7d6c9d4bc8e0e9ff28985a8a74a8fa59 Mon Sep 17 00:00:00 2001
From: Arnaud Watlet <arnaud.watlet@umons.ac.be>
Date: Wed, 17 Jan 2024 15:30:00 +0100
Subject: [PATCH] updates doc software
---
.../source_rst/software/operations/config.rst | 26 +++++++++----------
1 file changed, 13 insertions(+), 13 deletions(-)
diff --git a/doc/source/source_rst/software/operations/config.rst b/doc/source/source_rst/software/operations/config.rst
index 0ea77e3c..dac9410d 100644
--- a/doc/source/source_rst/software/operations/config.rst
+++ b/doc/source/source_rst/software/operations/config.rst
@@ -1,13 +1,13 @@
- .. _config:
+.. _config:
Configuration
*************
-The configuration of the OhmPi file `config.py` tells the software how the hardware is set up, cabled and configured.
+The configuration file `config.py` defines how the OhmPi system is assembled and expected to behave. It tells the software how the hardware is set up, cabled and configured.
In certain cases, it also allows you to define hardware specifications, such as the maximum voltage that a specific MUX board can handle.
For general purpose, most specifications can be left on default values.
.. warning::
- The configuration file defines how the OhmPi system is assembled and expected to behave. Not to be confused with :ref:`settings`. One configuration specified in a config.py file can handle multiple combinations of acquisition settings.
+ Not to be confused with :ref:`settings`. One configuration specified in a config.py file can handle multiple combinations of acquisition settings.
Default configuration
---------------------
@@ -27,21 +27,21 @@ Configuration file structure
----------------------------
The configuration is written in a python file structured in a series of dictionnaries related to:
-1. OHMPI_CONFIG: the OhmPi instrument information (id of the instrument and default settings)
-2. HARDWARE_CONFIG: the hardware system in which the five different modules 'ctl' (controller), 'tx' (transmitter), 'rx' (receiver), 'mux' (multiplexers), 'pwr' (power).
-3. the logging dictionnaries divided in:
- - EXEC_LOGGING_CONFIG
- - DATA_LOGGING_CONFIG
- - SOH_LOGGING_CONFIG
-4. the MQTT dictionnaries divided in:
- - MQTT_LOGGING_CONFIG
- - MQTT_CONTROL_CONFIG
+#. OHMPI_CONFIG: the OhmPi instrument information (id of the instrument and default settings)
+#. HARDWARE_CONFIG: the hardware system in which the five different modules 'ctl' (controller), 'tx' (transmitter), 'rx' (receiver), 'mux' (multiplexers), 'pwr' (power).
+#. the logging dictionnaries divided in:
+* EXEC_LOGGING_CONFIG
+* DATA_LOGGING_CONFIG
+*SOH_LOGGING_CONFIG
+#. the MQTT dictionnaries divided in:
+* MQTT_LOGGING_CONFIG
+* MQTT_CONTROL_CONFIG
.. toctree::
:maxdepth: 2
:caption: Contents:
-.. automodule:: ~configs.config_default
+.. automodule:: configs.config_default
:members:
:undoc-members:
:show-inheritance:
--
GitLab