From 4ebb129b90e2f6f04f8efe7be80441caf47ce06f Mon Sep 17 00:00:00 2001 From: Arnaud Watlet <arnaud.watlet@umons.ac.be> Date: Wed, 17 Jan 2024 15:09:16 +0100 Subject: [PATCH] updates doc software --- doc/source/source_rst/software/operations/config.rst | 2 ++ doc/source/source_rst/software/operations/settings.rst | 1 + 2 files changed, 3 insertions(+) diff --git a/doc/source/source_rst/software/operations/config.rst b/doc/source/source_rst/software/operations/config.rst index ceb54d35..ef3cc7e2 100644 --- a/doc/source/source_rst/software/operations/config.rst +++ b/doc/source/source_rst/software/operations/config.rst @@ -5,7 +5,9 @@ Configuration The configuration of the OhmPi file `config.py` 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 is expected to behave. It has a different purpose than the measurement settings which define the acquisition parameters. Several combinations of `settings`_ can be handled by one configuration specified in a config.py file. A default version of `config.py` is provided in the repository. diff --git a/doc/source/source_rst/software/operations/settings.rst b/doc/source/source_rst/software/operations/settings.rst index d88b573e..aeffde40 100644 --- a/doc/source/source_rst/software/operations/settings.rst +++ b/doc/source/source_rst/software/operations/settings.rst @@ -1,3 +1,4 @@ +.. _settings: Acquisition settings ******************** -- GitLab