Skip to content

D
distributed oscilloscope
Commit ebb753c4 authored by Milosz Malczak's avatar Milosz Malczak
Browse files
Options

docs: after check with grammarly

parent aa6e6cfb
Hide whitespace changes
Inline Side-by-side
Showing with 30 additions and 30 deletions
documentation/sphinx/installation.rst
View file @ ebb753c4
......@@ -12,13 +12,13 @@ Applications
.. important::
In order to be able to access the ADC device, the ref::`dependencies` have to be installed.
To be able to access the ADC device, the ref::`dependencies` have to be installed.
In order to use the DO, the python version 3.6 is required.
To use the DO, the python version 3.6 is required.
Before installing the Distributed Oscilloscope and the requirements, create a python virtual environment in order to avoid issues with packages versions.
Before installing the Distributed Oscilloscope and the requirements, create a python virtual environment to avoid issues with packages versions.
.. code-block:: console
......@@ -26,7 +26,7 @@ Before installing the Distributed Oscilloscope and the requirements, create a py
$ source do_venv/bin/activate
In order to install the Distributed Oscilloscope, type:
To install the Distributed Oscilloscope, type:
.. code-block:: console
......@@ -41,26 +41,26 @@ Now, three available applications could be started form the terminal:
Each of the applications requires installation of dependencies.
In order to install the dependencies for the Server, issue:
To install the dependencies for the Server, issue:
.. code-block:: console
$ pip install -r https://ohwr.org/project/distributed-oscilloscope/raw/master/software/DistributedOscilloscope/server/requirements.txt
In order to install the dependencies for the GUI, issue:
To install the dependencies for the GUI, issue:
.. code-block:: console
$ pip install -r https://ohwr.org/project/distributed-oscilloscope/raw/master/software/DistributedOscilloscope/applications/pyqt_app/requirements.txt
In order to install the dependencies for the ADC node, issue:
To install the dependencies for the ADC node, issue:
.. code-block:: console
$ pip install -r https://ohwr.org/project/distributed-oscilloscope/raw/master/software/DistributedOscilloscope/nodes/adc_lib_node/requirements.txt
In order to display help for each of the applications, type the name of the applications with '-h' option, e.g.:
To display help for each of the applications, type the name of the applications with '-h' option, e.g.:
.. code-block:: console
......@@ -74,7 +74,7 @@ Dependencies
===========
In order to be able to access the ADC device, the following drivers need to be loaded:
To be able to access the ADC device, the following drivers need to be loaded:
* htvic.ko:
https://gitlab.cern.ch/cohtdrivers/coht-vic
......
documentation/sphinx/introduction.rst
View file @ ebb753c4
......@@ -15,7 +15,7 @@ The idea of the DO is presented in :numref:`fig_problem_description`.
:alt: alternate text
:figclass: align-center
Synchronous acqusition of distributed data
Synchronous acquisition of distributed data
Analog signals from various digitizers are time-stamped, aligned to the same moment in time and sent to the Graphical User Interface (GUI), to be displayed. The synchronization is obtained using the White Rabbit Trigger Distribution `(WRTD) <https://www.ohwr.org/project/wrtd>`_ project.
......@@ -23,7 +23,7 @@ Analog signals from various digitizers are time-stamped, aligned to the same mom
Architecture
===========
The DO constits of three layers:
The DO constists of three layers:
* `User Applications`_
* `DO Server`_
......@@ -41,7 +41,7 @@ The structure of the DO is presented in :numref:`fig_DO_basic_schematics`.
Structure of the DO
The DO Server is a proxy between Devices and Users Applications. In a single network there could be one Server, multiple Users and multiple devices. The applications typically are run on different machines, but it is not a restriction.
The DO Server is a proxy between Devices and Users Applications. In a single network, there could be one server, multiple users and multiple devices. The applications typically are run on different machines, but it is not a restriction.
......@@ -61,7 +61,7 @@ The User Applications serve the following purposes:
* Collecting and processing the acquisition data
The Device Applications never communicate with the devices directly, always through the DO Server. This allows to hide all the implementation details and to provide a common interface for various types of applications.
The details how to write User Applications are described in section :ref:`user_applications`
The details on how to write User Applications are described in section :ref:`user_applications`
================
`DO Server`_
......@@ -74,7 +74,7 @@ The DO Server is a central unit responsible for managing all the connections, pr
`Device Application`_
================
Device applications provide a 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>`_.
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>`_.
Hardware setup
......@@ -86,11 +86,11 @@ The minimum hardware requirements necessary to demonstrate features of the DO ar
.. note::
The DO is designed to run each application on different machine. However, it is possible ot run them on the same machine. Also, to make the DO really distributed, the ADC cards should be installed in different locations in different machines. The described hardware setup should serve only as a demonstrator.
The DO is designed to run each application on a different machine. However, it is possible to run them on the same machine. Also, to make the DO really distributed, the ADC cards should be installed in different locations in different machines. The described hardware setup should serve only as a demonstrator.
.. note::
CentOS 7.6.1810 guaranties that all the drivers will function properly. However, it is possible to use the DO with different OS. In case of the machines where the Server and the GUI are run, the Linux version does not matter.
CentOS 7.6.1810 guaranties that all the drivers will function properly. However, it is possible to use the DO with different OS. In case of machines where the Server and the GUI are run, the Linux version does not matter.
* `White Rabbit Switch <https://www.ohwr.org/projects/white-rabbit/wiki/switch>`_
......@@ -98,9 +98,9 @@ The minimum hardware requirements necessary to demonstrate features of the DO ar
.. important::
The DO will work only with SPEC 150T version. Be carrefoul not to purchase standard SPEC 45T version.
The DO will work only with SPEC 150T version. Be careful not to purchase standard SPEC 45T version.
* 2 `FMC ADC 100M 14b 4cha <https://www.ohwr.org/project/fmc-adc-100m14b4cha/wikis/home>`_ boards
* 2 fibres -- in order to demonstrate the synchronization features, the fibres could be of different lenghts
* 2 fibers -- to demonstrate the synchronization features, the fibers could be of different lengths
* 4 SFP cages
* signal generator
......@@ -117,5 +117,5 @@ The minimum hardware setup of the DO is presented in :numref:`fig_hardware_setup
The SPEC boards togehter with ADC cards should be installed in PCIe slots of the computer and connected to any of White Rabbit switch Channels using the SFP cages and fibres. In order to be able to demonstrate the synchronization accuracy, the same signal from the generator should be provided to both ADCs, with cables of the same length or precisely known lengths.
The SPEC boards together with ADC cards should be installed in PCIe slots of the computer and connected to any of White Rabbit switch Channels using the SFP cages and fibers. To be able to demonstrate the synchronization accuracy, the same signal from the generator should be provided to both ADCs, with cables of the same length or precisely known lengths.
documentation/sphinx/startup.rst
View file @ ebb753c4
......@@ -4,9 +4,9 @@
Starting Applications
================
In order to use the GUI, also the Server and the ADC node have to be run. 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.
To use the GUI, also the Server and the ADC node have to be run. 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.
The first application that have to be run is the Server. When the Server is already started, GUIs and ADC nodes can be run in any order.
The first application that has to be run is the Server. When the Server is already started, GUIs and ADC nodes can be run in any order.
Before starting any of the applications, start the virtual environment and install the Distributed Oscilloscope, as described in section :ref:`inst_app`.
......@@ -15,7 +15,7 @@ Before starting any of the applications, start the virtual environment and insta
Server Application
---------------
In order to start the Server Application, run in terminal:
To start the Server Application, run in terminal:
.. code-block:: console
......@@ -30,7 +30,7 @@ Optional arguments:
GUI:
----------------
Before staring the GUI applications, find out what is the ip address of the Server: SERVER_IP_ADDRESS. You can check it using the command:
Before starting the GUI applications, find out what is the IP address of the Server: SERVER_IP_ADDRESS. You can check it using the command:
.. code-block:: console
......@@ -38,7 +38,7 @@ Before staring the GUI applications, find out what is the ip address of the Serv
$ ifconfig
In order to start the GUI, run in terminal:
To start the GUI, run in terminal:
.. code-block:: console
......@@ -58,14 +58,14 @@ 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.
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.
.. important::
The Zeroconf will only work if the Server and the ADC are in the same local networks. Otherwise, the IP of the Server has to be provided manually.
In order to start the GUI, run in terminal:
To start the GUI, run in terminal:
.. code-block:: console
......
documentation/sphinx/usage.rst
View file @ ebb753c4
......@@ -34,7 +34,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 signal of the observed channel crosses the threshold value.
The ADCs could be triggered either by external trigger pulse or when the signal of the observed channel crosses the threshold value.
.. figure:: graphics/GUI_triggers_selection.png
:name: fig_gui_trigg_sel
......@@ -79,7 +79,7 @@ If the external trigger is selected, the GUI could be triggered by the external
Channels settings
----------------
Currently available channels settings are following:
Currently available channels settings are the following:
* range
* termination
......@@ -98,7 +98,7 @@ Currently available channels settings are following:
Trigger settings
----------------
Currently available trigger settings are following:
Currently available trigger settings are the following:
* polarity
* delay
......@@ -135,7 +135,7 @@ There are two available modes:
Acquisition settings
--------------------
Acquisition settings allow to modify the acquisition time and position of the trigger. Position of the trigger is given in percentage of the acquisition time.
Acquisition settings allow modifying the acquisition time and position of the trigger. Position of the trigger is given in percentage of the acquisition time.
.. figure:: graphics/GUI_acquisition_settings.png
:name: fig_gui_acq_set
......
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