Commit c6a8f41c authored by Milosz Malczak's avatar Milosz Malczak

docs: fixed titles overlines

parent 4f2d6818
.. _installation:
Installation
===========
=============
.. _inst_app:
===========
=============
Applications
===========
=============
.. important::
......@@ -69,9 +69,9 @@ To display help for each of the applications, type the name of the applications
.. _dependencies:
===========
=============
Dependencies
===========
=============
To be able to access the ADC device, the following drivers need to be loaded:
......
.. _introduction:
-----------
-------------
Introduction
-----------
-------------
The Distributed Oscilloscope (DO) is an application allowing to synchronously monitor analog signals in a distributed system, independently of the distance.
......@@ -21,7 +21,7 @@ Analog signals from various digitizers are time-stamped, aligned to the same mom
Architecture
===========
==============
The DO constists of three layers:
......@@ -46,9 +46,9 @@ The DO Server is a proxy between Devices and Users Applications. In a single net
================
=====================
`User Applications`_
================
=====================
There are currently two User Applications available:
......@@ -70,15 +70,15 @@ The details on how to write User Applications are described in section :ref:`dev
The DO Server is a central unit responsible for managing all the connections, preprocessing the data and providing a common interface for connected applications.
================
======================
`Device Application`_
================
======================
Device applications provide direct access to hardware resources. At the moment the only available devices are ADCs supported by the `adc-lib <https://ohwr.org/project/adc-lib/wikis/home>`_.
Hardware setup
==============
================
The minimum hardware requirements necessary to demonstrate features of the DO are the following:
......
......@@ -2,7 +2,7 @@
Starting Applications
================
======================
The GUI and the Server can be run on any Linux machine with python3.6. Before starting the ADC application, all the dependencies, described in section :ref:`dependencies`, have to be installed.
......@@ -13,7 +13,7 @@ Before starting any of the applications, start the virtual environment and insta
Server Application
---------------
--------------------
To start the Server Application, run in terminal:
......@@ -56,7 +56,7 @@ Optional arguments:
ADC application:
----------------
------------------
If the Server and the ADC device are in different local networks, before staring the ADC applications, find out what is the IP address of the Server: SERVER_IP_ADDRESS. If the IP address of the Server is not provided, Zeroconf will be used to automatically find out this information.
......@@ -80,7 +80,7 @@ Optional arguments:
Examples configuration:
----------------
-------------------------
Supposing that the IP address of the Server is 128.141.79.22, the ADCs are installed in the same machine and the PCI slots where the ADCs are installed are 01 and 02, the applications have to be started with following parameters:
.. code-block:: console
......
......@@ -32,7 +32,7 @@ Just like in standard oscilloscope, there is a possibility of observing up to 4
Triggers selection
-----------------
------------------
The ADCs could be triggered either by external trigger pulse or when the signal of the observed channel crosses the threshold value.
......@@ -77,7 +77,7 @@ If the external trigger is selected, the GUI could be triggered by the external
Channels settings
----------------
-----------------
Currently available channels settings are the following:
......
Markdown is supported
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