Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ pip install -e . # editable mode allows changes to have instant impact
## Documentation build
```commandline
. venv/bin/activate
pip install -U sphinx sphinx-autosummary-accessors sphinx_immaterial
pip install sphinx==8.2.3 sphinx-autosummary-accessors==2025.3.1 sphinx_immaterial==0.13.9

make -C docs html
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Install sphinx dependencies to be able to build the documentation:
.. code-block:: bash

. ibex_venv/bin/activate
pip install -U sphinx sphinx-autosummary-accessors sphinx_immaterial
pip install sphinx==8.2.3 sphinx-autosummary-accessors==2025.3.1 sphinx_immaterial==0.13.9

**Build the documentation**

Expand Down
16 changes: 14 additions & 2 deletions docs/source/users_manual/features/configuration_file.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ When you save a configuration, a file in the following format will be created. I

You can share configuration files with other users to quickly access their workspace.

You can also edit the file manually before loading it. However, this is dangerous and should only be done with caution by experienced users, as incorrect edits could cause unwanted bugs in the configuration.
You can also edit the file manually before loading it. However, this is not recommended and dangerous. It should only be done with caution by experienced users, as incorrect edits could cause unwanted bugs in the configuration.

Exemple configuration file :

Expand All @@ -27,6 +27,11 @@ Exemple configuration file :
"title": "t_e_URI-0",
"isTitleOverwritten": false,
"displayErrorBand": false,
"synchronizedGrids": {
"color": "",
"list": []
},
"interpolated_method": "exact_value",
"xAxisData": {
"name": "time",
"unit": "s",
Expand All @@ -43,11 +48,13 @@ Exemple configuration file :
"h": 12,
"coordinates": [
{
"axeIndex": 0,
"path": "#ece/time",
"target": "#ece/channel[0]/t_e/data[0]",
"valueIndex": 0
},
{
"axeIndex": 1,
"path": "",
"target": "#ece/channel[0]",
"valueIndex": 0
Expand All @@ -57,7 +64,12 @@ Exemple configuration file :
{
"nodeUri": "URI-0#ece:0/channel[0]/t_e/data",
"yaxis": "",
"labelUri": "URI-0"
"labelUri": "URI-0",
"line": {
"color": "rgb(31, 119, 180)"
},
"customPreferences": {},
"mode": "line"
}
]
}
Expand Down
77 changes: 55 additions & 22 deletions docs/source/users_manual/features/customization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,69 +5,102 @@ Customization
Overview
--------------------

Here is the customization component:
The customization component is divided into sections accessible on the right.

.. image:: images/customization_main.png
:alt: Customization component
It is used for data manipulation as well as visual customization. Depending on the type of customization you choose, the corresponding features will be displayed.

Here is the data manipulation:

.. image:: images/customization_data_main.png
:alt: Data manipulation component
:align: center

The customization is divided into sections accessible on the right.
And here is the visual customization:

.. image:: images/customization_visual_main.png
:alt: Visual customization component
:align: center

When you make changes, you can see the updates reflected in the graph on the left.

You can undo changes by clicking the button with the red X in the upper-left corner. Otherwise, simply click the button with the orange checkmark to apply the customization.

Data manipulation
--------------------

Downsampling
~~~~~~~~~~~~~~~~~~~~~~~~

Applies a downsampling method to reduce the data size while preserving its original appearance:

.. image:: images/customization_downsampling.png
:alt: Downsampling section of the data manipulation
:align: center

Interpolation
~~~~~~~~~~~~~~~~~~~~~~~~

Applies an interpolation method to fill gaps between data points by estimating intermediate values:

.. image:: images/customization_interpolation.png
:alt: Interpolation section of the data manipulation
:align: center


Visual customization
----------------------------

Global
--------------------
~~~~~~~~~~~~

Allows you to modify general parameters of a graph:

.. image:: images/customization_global.png
:alt: Global section of the customization
:alt: Global section of the visual customization
:align: center

1D plots
--------------------
~~~~~~~~~~~~

Allows you to customize the appearance of 1D plots:

.. image:: images/customization_1d_plot.png
:alt: 1D plots section of the customization
:alt: 1D plots section of the visual customization
:align: center

Heatmap
--------------------
~~~~~~~~~~~~

Allows you to modify the color scale of the heatmap:

.. image:: images/customization_heatmap.png
:alt: Heatmap section of the customization
:alt: Heatmap section of the visual customization
:align: center

Axis range
--------------------
Geometry
~~~~~~~~~~~~

Allows you to trim data for a more detailed visualization:
Allows you to overlay geometries:

.. image:: images/customization_axis_range.png
:alt: Axis range section of the customization
.. image:: images/customization_geometry.png
:alt: Geometry section of the visual customization
:align: center

Downsampling
--------------------

Applies a downsampling method to reduce the data size while preserving its original appearance:
Axis range
~~~~~~~~~~~~

.. image:: images/customization_downsampling.png
:alt: Downsampling section of the customization
Allows you to trim data for a more detailed visualization:

.. image:: images/customization_axis_range.png
:alt: Axis range section of the visual customization
:align: center

Dataplot synchronization
---------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Allows you to link plots by their coordinates to facilitate comparison when using sliders:

.. image:: images/customization_synchronization.png
:alt: Synchronization section of the customization
:alt: Synchronization section of the visual customization
:align: center
12 changes: 6 additions & 6 deletions docs/source/users_manual/features/draggable_component.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,6 @@ Each chart includes several options:
:alt: Plot data with slider
:align: center

**Downsampling method:**

Selecting the downsampling method reduces the amount of data to be displayed while preserving the visual appearance of the data.

**Error bands:**

Enabling or disabling error bars allows you to load the "_error_upper" & "_error_lower" data to represent them as vertical lines.
Expand All @@ -35,9 +31,13 @@ Allows you to select how you want the data to be displayed. In 1D, it will be re

This opens a ":doc:`Metadata <metadatas>`" component that displays various information related to all nodes (path, min, max, average, value, coordinates, etc.). This gives the user a broader overview of the data.

**Customize the grid:**
**Data manipulation:**

It opens a ":doc:`Customization <customization>`" component which allows to personnalize the grid. It includes data manipulation features.

**Visual customization:**

It opens a ":doc:`Customization <customization>`" component which allows to personnalize the grid.
It opens a ":doc:`Customization <customization>`" component which allows to personnalize the grid. It includes visual customization features.

**Edit Grid:**

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/users_manual/features/images/plot_data.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/users_manual/features/images/plot_data_heatmap.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/source/users_manual/features/plot_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Plot data

To plot a data point on a chart, simply click on the corresponding node in the tree. Each node is preceded by a checkbox : you can either click the checkbox or directly click the node name. This will create a component in the draggable area on the right.

You can plot 1D / heatmap charts with one or multiple nodes, as long as they share the same X-axis. Up to two different Y-axes can be displayed simultaneously.
You can plot 1D / heatmap / contour charts with one or multiple nodes, as long as they share the same X-axis. Up to two different Y-axes can be displayed simultaneously.

.. image:: images/plot_data.png
:alt: Plot simple data
Expand All @@ -20,7 +20,7 @@ Some data has dependencies represented as sliders. It is possible to explore the

By default, the chart title is generated using the node's name, unit, and associated URI. The Y-axes are labelled with the name of the first plotted plot and their unit. Finally, the X-axis is labeled with the name used to retrieve coordinates and his unit. Each data series is distinguished by a default color.

We can switch to the 1D / heatmap display by clicking on the corresponding button.
We can switch to the 1D / heatmap / Contour display by clicking on the corresponding button.

.. image:: images/plot_data_heatmap.png
:alt: Heatmap plot data with
Expand Down
2 changes: 1 addition & 1 deletion docs/source/users_manual/features/tree.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ After selecting your URIs, you can navigate through the hierarchy to find your d

In each URI, at the first level, you will find the IDS of each occurrence. For each IDS, you will find the corresponding tree.

In this tree, there are different types of data (Structure, Table, Float, Integer, Text), and each type will have its corresponding icon, except for Structures and Tables, which will share the same icon.
In this tree, there are different types of data (Structure, Table, Float, Integer, Text, Complex), and each type will have its corresponding icon, except for Structures and Tables, which will share the same icon.

.. image:: images/tree.png
:alt: Tree uri to select data to plot
Expand Down
Loading