diff --git a/README.md b/README.md index a37c03d..9c51b39 100644 --- a/README.md +++ b/README.md @@ -7,15 +7,41 @@ Application in python that draws graphs of analog signals, developed for university course digital measuring techniques (*pl. cyfrowe techniki pomiarowe*). It contains functions that simplifies calculations that we conducted during our laboratories. + ## About +Application lets users select one of calculation modules. Currently, two modules are available: the Displacement Module and the Flow Module. The thoughtful architecture allows for the easy addition of new modules in the future. These modules share some core functionalities while also offering specialized functions unique to them. + +Shared functionalities include: + +- Drawing multiple plots based on the chosen module, +- Specifying the instrument's measuring range, +- Calculating and displaying statistics in the left pane, +- Setting limit values for each graph, +- Defining sampling intervals (span) for graph generation. + + +### 1. Displacement module: + +This module allows users to visualize displacement data recorded as an analog signal. It also helps the analysis by calculating and plotting the signal's velocity and acceleration. + screen_displacement_module + +### 2. Flow module: + +This module allows users to visualize and analize flow data recorded as an analog singal. It draws 3 plots: voltage plot, x plot which is multiplied voltage by device range and the velocity of x. + +Additionally in flow mode users can: +- Specify pipe diameter, +- Get calculated cross-sectional area, Flow value and V-average. + screen_flow_module ## Usage To run program you simply need to download most recent version of repo and cd into directory + ```bash git clone https://github.com/bartekbiz/ctplot cd ctplot @@ -37,27 +63,14 @@ python3 main.py ``` - -## Functions - -Selection of counting modes (Discplacement/Flow) -Possibility to specify the measuring range of the instrument -Display of chart limit values -Possibility of specifying limit values for each graph -Possibility to specify sampling values for graph drawing(span) -Chart reset button(reset) -Button for activating changes to chart limits(apply) - -Additionally in flow mode -Pipe diameter can be specified(Diameter) -Display of chart limit values and cross-sectional area, V-average and Flow value - ## Authors CTPlot was created by [Mateusz Grochowski](https://github.com/Gromate), [Bartek Bizoń](https://github.com/bartekbiz/), [Filip Gnojek](https://github.com/alien2fg) and [Vladyslav Dikhtiaruk](https://github.com/vladdikhtia) + ## License GNU General Public License v3.0 or later See [LICENSE](LICENSE) to see the full text. +