Skip to content
GitLab
Commit d67c1927 authored by Arnaud WATLET's avatar Arnaud WATLET
Browse files

updates software doc

parent 52fb8bb9
master 144-create-testing-framework-for-tests-automation v2024_rc v2024.0.35 v2024.0.34 v2024.0.33 v2024.0.32 v2024.0.31 v2024.0.30 v2024.0.29 v2024.0.28 v2024.0.27 v2024.0.26 v2024.0.25 v2024.0.24 v2024.0.23 v2024.0.22 v2024.0.21 v2024.0.20 v2024.0.19 v2024.0.18 v2024.0.17 v2024.0.16 v2024.0.15 v2024.0.14 v2024.0.13 v2024.0.12 v2024.0.11 v2024.0.10 v2024.0.9 v2024.0.8 v2024.0.7 v2024.0.0
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 23 additions and 5 deletions
+23 -5
doc/source/source_rst/software/operations/config.rst
+ 23
− 5
View file @ d67c1927
......@@ -62,6 +62,7 @@ The configuration is written in a python file structured in a series of dictiona
#. HARDWARE_CONFIG: the hardware system in which the five different modules 'ctl' (controller), 'tx' (transmitter), 'rx' (receiver), 'mux' (multiplexers), 'pwr' (power).
.. _table_hardware_config:
.. table:: HARDWARE_CONFIG
+----------+----------------+---------------------------------------------------------------------------------------------------------------------------------------+
......@@ -117,15 +118,32 @@ The configuration is written in a python file structured in a series of dictiona
+----------+----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+
| mux | boards | | Dictionary containing all MUX boards of the | | |
| | | | system and the associated specific | | |
| | | | configuration. | mux_id | Dictionary |
| | | | configuration. | mux_id | Dictionary (see table_mux_config_) |
| +----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+
| | default | | Dictionary containing configuration applicable | | |
| | | | to all MUX boards of the systems | deffault_dict | Dictionary |
| | | | to all MUX boards of the systems | default_dict | Dictionary (see table_mux_config_) |
+----------+----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+
.. autodata:: configs.config_example.HARDWARE_CONFIG
.. _table_mux_config:
.. table:: MUX board config in HARDWARE_CONFIG
+----------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| Module Key | Value |
| +--------------------------------------------------+-------------------------+-----------------------------------------------------------------+
| | Description | Expected Value | Value description |
+================+==================================================+=========================+=================================================================+
| model | Type of Mux board. | mux_2024_0_X | | Load RX defined in |
| | | | | :func:`ohmpi.hardware_components.mux_2024_0_X` |
| | +-------------------------+-----------------------------------------------------------------+
| | | mux_2023_0_X | | Load RX defined in |
| | | | | :func:`ohmpi.hardware_components.mux_2023_0_X` |
+----------------+--------------------------------------------------+-------------------------+-----------------------------------------------------------------+
| electrodes | List of electrodes addressed by the MUX board | | *array-like*, | Sets electrode IDs addressed by the MUX board |
| | | | e.g. range(1,65) | |
+----------------+--------------------------------------------------+-------------------------+-----------------------------------------------------------------+
| roles | roles addressed by the MUX board | | *string, list* | Sets roles addressed by the MUX board |
| | | | of 'A', 'B', 'M', 'N' | |
+----------------+--------------------------------------------------+-------------------------+-----------------------------------------------------------------+
.. code-block:: python
:caption: HARDWARE_CONFIG: Dictionary containing configuration of the hardware system and how it is assembled.
r_shunt = 2. # Value of the shunt resistor in Ohm.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment