You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/getting_started.md
+32-32Lines changed: 32 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,20 +2,20 @@
2
2
3
3
In this tutorial, we will guide you through the first steps to get started with PowerAPI.
4
4
The objective is to get a quick view of the capabilities of PowerAPI, by monitoring a process and getting a quick glimpse at the energy consumption.
5
-
A few things are required before we start:
5
+
A few things are required before we start:
6
6
7
-
- A compatible processor, you can see the compatible CPU architecture [here](./reference/sensors/hwpc-sensor.md#) and you can look on the following pages to find your CPU architecture:
7
+
- A compatible processor (you can see the compatible CPU architecture [here](./reference/sensors/hwpc-sensor.md#)), and you can look on the following pages to find your CPU architecture:
8
8
* For [Intel Processor](https://en.wikipedia.org/wiki/List_of_Intel_processors)
9
9
* For [Intel Xeon Processor](https://en.wikipedia.org/wiki/List_of_Intel_Xeon_processors)
10
10
* For [AMD Processor](https://en.wikipedia.org/wiki/Table_of_AMD_processors)
11
11
- A python installation ready
12
12
- Docker & Docker-Compose ready (refer to [this official documentation](https://docs.docker.com/engine/install/) and the [post-install steps](https://docs.docker.com/engine/install/linux-postinstall/) if needed !)
13
13
- Root access
14
-
-Optionnal : [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) to proceed by clonning the repository
14
+
-Optional : [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) to proceed by clonning the repository
15
15
16
16
## Which components to get a complete stack
17
17
18
-
If you wish to get started as soon as possible, the following archive will allow you to deploy the following elements:
18
+
If you wish to get started as soon as possible, the archive below will allow you to deploy the following elements:
19
19
20
20
1. A MongoDB instance to store the [Sensor](./reference/sensors/hwpc-sensor.md)
21
21
Reports
@@ -32,50 +32,50 @@ quick glimpse
32
32
33
33
## Preparation
34
34
35
+
You can either download the archive by cloning the repository or using wget.
cd powerapi-ng.github.io/docs/script/getting-started
41
+
```
47
42
48
-
From this archive, you will have all the necessary files to get started, let us break down each element.
43
+
=== "wget"
44
+
```
45
+
wget -c https://raw.githubusercontent.com/powerapi-ng/powerapi-ng.github.io/refs/heads/master/docs/script/getting_started.tar.gz -O - | tar -xz
46
+
cd getting_started
47
+
```
49
48
49
+
At this stage, you will have all the essential files to begin. Let's go through each element in detail.
50
50
### Archive content
51
51
52
52
```sh
53
-
|getting_started/
54
-
|--csv/
55
-
|--fomula/
56
-
|----smartwatts-mongodb-csv.json
57
-
|--sensor/
58
-
|----hwpc-mongodb.json
59
-
|--start.sh
60
-
|--start.py
61
-
|--stop.sh
62
-
|--pretty_print.py
63
-
|--docker-compose.yaml
64
-
|--.env
53
+
getting_started/
54
+
|--csv/
55
+
|--fomula/
56
+
|----smartwatts-mongodb-csv.json
57
+
|--sensor/
58
+
|----hwpc-mongodb.json
59
+
|--start.sh
60
+
|--start.py
61
+
|--stop.sh
62
+
|--pretty_print.py
63
+
|--docker-compose.yaml
64
+
|--.env
65
65
```
66
66
67
67
#### HWPC-Sensor and SmartWatts Configuration
68
68
69
-
As described in the [HWPC-Sensor Documentation](./reference/sensors/hwpc-sensor.md#global-parameters) and in the [SmartWatts Documentation](./reference/formulas/smartwatts.md#global-parameters)
69
+
As described in the [HWPC-Sensor Documentation](./reference/sensors/hwpc-sensor.md#global-parameters) and in the [SmartWatts Documentation](./reference/formulas/smartwatts.md#global-parameters),
70
70
several parameters can be set, both globally and for specific Groups monitored for the sensor or the formula.
71
71
72
-
The provided docker-compose.yaml file use configuration files and the **.env** to set those parameters.
73
-
You can find example of both those configuration files in the archive under the **formula** and **sensor** directories.
72
+
The provided docker-compose.yaml file uses configuration files and the **.env** to set those parameters.
73
+
You can find examples of both those configuration files in the archive under the **formula** and **sensor** directories.
74
74
75
75
76
76
## Turn the key
77
77
78
-
Once all set, you shall be able to initiate the stack with:
78
+
Once all set, you shall be able to initiate the stack with:
0 commit comments