doc: fix spelling

Author: TheElectronWill

.cspell.json

@@ -5,7 +5,8 @@
     "enableGlobDot": true,
     "language": "en",
     "dictionaries": [
-        "project-words"
+        "project-words",
+        "grid5000",
     ],
     "ignorePaths": [
         "*.toml",
@@ -21,6 +22,11 @@
             "name": "project-words",
             "path": ".cspell/project-words.txt",
             "addWords": true
+        },
+        {
+            "name": "grid5000",
+            "path": ".cspell/grid5000.txt",
+            "addWords": true
         }
     ],
     "languageSettings": [
@@ -29,7 +35,8 @@
             "ignoreRegExpList": [
                 "markdown_code_block",
                 "markdown_inline_code",
-                "name_surname"
+                "name_surname",
+                "math_equation_latex",
             ]
         }
     ],
@@ -45,6 +52,10 @@
         {
             "name": "name_surname",
             "pattern": "[A-Z]\\w+ [A-Z]\\w+"
+        },
+        {
+            "name": "math_equation_latex",
+            "pattern": "\\$\\$.+\\$\\$"
         }
     ],
     "enabled": true

.cspell/grid5000.txt

@@ -0,0 +1,9 @@
+chiroptera
+neowise
+oar
+paradoxe
+quarch
+quarchpy
+sagittaire
+servan
+wattmetre

.cspell/project-words.txt

@@ -1,15 +1,24 @@
+acpi
 Alumet
 Atos
+downsampling
 Eviden
-rapl
-RAPL
-rustup
-libc
 Jetson
-downsampling
+kwollect
+libc
 mdbook
-pagetoc
-slurm
-oar
+milli
 nvml
+pagetoc
+powercap
 powermeters
+rapl
+RAPL
+rustup
+SCPI
+slurm
+superchip
+superchips
+tracepoints
+UCUM
+wattmeters

src/plugins/1_sources/nvidia-jetson.md

@@ -19,9 +19,9 @@ Depending on the hardware, some metrics may or may not be collected.
 
 |Name|Type|Unit|Description|Attributes|
 |----|----|----|-----------|----------|
-|`input_current`| u64 | mA (milli-Ampere) | current intensity on the channel's line | see below |
-|`input_voltage`| u64 | mV (milli-Volt)| current voltage on the channel's line    | see below |
-|`input_power`  | u64 | mW (milli-Watt)| instantaneous electrical power on the channel's line    | see below |
+|`input_current`| u64 | mA (milliAmpere) | current intensity on the channel's line | see below |
+|`input_voltage`| u64 | mV (milliVolt)| current voltage on the channel's line    | see below |
+|`input_power`  | u64 | mW (milliWatt)| instantaneous electrical power on the channel's line    | see below |
 
 ### Attributes
 

src/plugins/1_sources/raw-cgroups.md

@@ -43,7 +43,7 @@ poll_interval = "1s"
 The version of the control groups and the mount point of the cgroupfs are automatically detected.
 
 The plugin watches for the creation and deletion of cgroups.
-With cgroup v2, the detection is almost instantaneous, because it relies on inotify.
+With cgroup v2, the detection is almost instantaneous, because it relies on `inotify`.
 With cgroup v1, however, cgroups are repeatedly polled. The refresh interval is `30s`, and it is currently not possible to change it in the plugin's configuration.
 
 ## More information

src/plugins/2_transforms/energy-estimation-tdp.md

@@ -12,27 +12,19 @@ Refer to the [wikipedia page of TDP](https://en.wikipedia.org/wiki/Thermal_desig
 
 In the first version of the plugin, we consider only the TDP of the CPU.
 
- This plugin requires the cgroupv2 input plugin (k8s) as it needs the input measurements of cgroups v2.
+This plugin requires the cgroupv2 input plugin (k8s) as it needs the input measurements of cgroups v2.
 
 The estimation calculation is done using the following formula:
 
 $$\Large Energy=\frac{cgroupv2*cpu total usage*nb\_vcpu*TDP}{10^6*pooling\_interval*nb\_cpu}$$  
 
-cgroupv2_cpu_total_usage:   total usage of CPU in micro seconds for a pod
-nb_vcpu:                    number of virtual CPU of the hosting machine where pod is running
-nb_cpu:                     number of physical CPU of the hosting machine where pod is running
-polling_interval:           polling interval of cgroupv2 input plugin
+- `cgroupv2_cpu_total_usage`:   total usage of CPU in micro seconds for a pod
+- `nb_vcpu`:                    number of virtual CPU of the hosting machine where pod is running
+- `nb_cpu`:                     number of physical CPU of the hosting machine where pod is running
+- `polling_interval`:           polling interval of cgroupv2 input plugin
 
 ## Energy estimation tdp plugin
 
-### How to use
-
-Just compile the app-agent of the alumet's github repository.
-
-```bash
-cargo run
-```
-
 The binary created by the compilation will be found under the target repository.
 
 ### Prepare your environment
@@ -45,24 +37,28 @@ To work this plugin needs k8s plugin configured, so the needed things are relate
 
 ### Configuration
 
+```toml
 [plugins.EnergyEstimationTdpPlugin]
 poll_interval = "30s"
 tdp = 100.0
 nb_vcpu = 1.0
 nb_cpu = 1.0
+```
 
-pool_interval: must be identical to the poll_interval of input k8s plugin. Default value is 1s.
-
-nb_vcpu: number of virtual cpu allocated to the virtual machine in case of kubernetes nodes are virtual machine. Using the kubectl get node command, you can retrieve the number of vcpu. If the kubernetes nodes are physical machine, assign it to value 1. Default value is 1.
+- `pool_interval`: must be identical to the poll_interval of input k8s plugin. Default value is 1s.
+- `nb_vcpu`: number of virtual cpu allocated to the virtual machine in case of kubernetes nodes are virtual machine. Using the kubectl get node command, you can retrieve the number of virtual cores. If the kubernetes nodes are physical machine, assign it to value 1. Default value is 1.
 
 To get the CPU capacity of a kubernetes node, execute the following command:
+
+```sh
 kubectl  describe node <node name> | grep cpu -B 2
   Hostname:    <node name>
 Capacity:
   cpu:                32
+```
 
-nb_cpu: number of physical cpu of the hosted machine. Using the lscpu or hwinfo, you can retrieve the number of cpu. If the kubernetes nodes are physical machine, assign it to value 1. Default value is 1.
+- `nb_cpu`: number of physical cpu of the hosted machine. Using the `lscpu` or `hwinfo`, you can retrieve the number of cpu. If the kubernetes nodes are physical machine, assign it to value 1. Default value is 1.
 
-tdp: Thermal Design power; each CPU has a calculated thermal design value; the value can be find on internet (usually on CPU manufacturer); you need the exact CPU family (using command lscpu or hwinfo). For example, for Intel® Xeon® D Processor, family D-2183IT, the tpd can be found [it's intel documentation page](https://ark.intel.com/content/www/us/en/ark/products/136441/intel-xeon-d-2183it-processor-22m-cache-2-20-ghz.html)
+tdp: Thermal Design power; each CPU has a calculated thermal design value; the value can be find on internet (usually on CPU manufacturer); you need the exact CPU family (using command `lscpu` or `hwinfo`). For example, for Intel® Xeon® D Processor, family D-2183IT, the tpd can be found [it's intel documentation page](https://ark.intel.com/content/www/us/en/ark/products/136441/intel-xeon-d-2183it-processor-22m-cache-2-20-ghz.html)
 tdp value is  100W.
 Default value is 100.