1
1
# ` projplot `
2
2
3
- ![ ] ( ./img/projplot_regular_use.png )
3
+ ![ Projplot plot ] ( ./img/projplot_regular_use.png )
4
4
5
5
` projplot ` is an UPPMAX tool to plot your core hour usage
6
6
7
7
## Minimal use
8
8
9
9
` projplot ` needs only the project code:
10
10
11
- ```
11
+ ``` bash
12
12
projplot -A [project_code]
13
13
```
14
14
15
15
For example:
16
16
17
- ```
17
+ ``` bash
18
18
projplot -A uppmax2020-2-2
19
19
```
20
20
21
21
Output will look similar to this:
22
22
23
- ![ ] ( ./img/projplot_regular_use.png )
23
+ ![ A projplot plot ] ( ./img/projplot_regular_use.png )
24
24
25
25
> Example ` projplot ` output. The horizontal axis
26
26
> shows the days before today, the vertical axis shows
@@ -57,7 +57,7 @@ your get those core hours back to the project.
57
57
If we look at a project that has used more core hours than their projects allocation,
58
58
the image will look like this:
59
59
60
- ![ ] ( ./img/projplot_over_quota.png )
60
+ ![ A projplot that is over quota ] ( ./img/projplot_over_quota.png )
61
61
62
62
There is a message about the core hour limit being reached at the top of the plot.
63
63
If you look in the diagram at around 10 days ago,
@@ -75,7 +75,7 @@ so for each core hour they use the more to the right the `>` bar will move.
75
75
76
76
` projplot ` has more options, that are shown by using ` --help ` :
77
77
78
- ```
78
+ ``` bash
79
79
projplot --help
80
80
```
81
81
@@ -85,7 +85,7 @@ Below, these options are discussed in detail.
85
85
86
86
Use ` --help ` (or ` -h ` ) to get a short description of the options and some examples:
87
87
88
- ```
88
+ ``` bash
89
89
projplot --help
90
90
```
91
91
@@ -149,14 +149,14 @@ projplot --help
149
149
Use ` --days ` (or ` -d ` ) the plot a custom number of days,
150
150
instead of the default of 30 days:
151
151
152
- ```
152
+ ``` bash
153
153
projplot -A [project_code] --days [number_of_days]
154
154
```
155
155
156
156
For example, this will plot the last 45 days:
157
157
:
158
158
159
- ```
159
+ ``` bash
160
160
projplot -A uppmax2020-2-2 --days 45
161
161
```
162
162
@@ -165,13 +165,13 @@ projplot -A uppmax2020-2-2 --days 45
165
165
Use ` --start ` (or ` -s ` ) to specify a custom starting date,
166
166
from when the time in your plot will start:
167
167
168
- ```
168
+ ``` bash
169
169
projplot -A [project_code] --start [starting_date_in_yyyy-mm-dd_format]
170
170
```
171
171
172
172
For example:
173
173
174
- ```
174
+ ``` bash
175
175
projplot -A uppmax2020-2-2 --start 2023-05-03
176
176
```
177
177
@@ -180,7 +180,7 @@ and the default number of days after that date.
180
180
The command below does exactly the same, yet makes the default
181
181
number of days explicit:
182
182
183
- ```
183
+ ``` bash
184
184
projplot -A uppmax2020-2-2 --start 2023-05-03 --days 30
185
185
```
186
186
@@ -189,13 +189,13 @@ projplot -A uppmax2020-2-2 --start 2023-05-03 --days 30
189
189
Use ` --end ` (or ` -e ` ) to specify a custom ending date,
190
190
from when the time in your plot will end:
191
191
192
- ```
192
+ ``` bash
193
193
projplot -A [project_code] --end [ending_date_in_yyyy-mm-dd_format]
194
194
```
195
195
196
196
For example:
197
197
198
- ```
198
+ ``` bash
199
199
projplot -A uppmax2020-2-2 --end 2023-05-03
200
200
```
201
201
@@ -204,7 +204,7 @@ and the default number of days before that date.
204
204
The command below does exactly the same, yet makes the default
205
205
number of days explicit:
206
206
207
- ```
207
+ ``` bash
208
208
projplot -A uppmax2020-2-2 --end 2023-05-03 --days 30
209
209
```
210
210
@@ -213,13 +213,13 @@ projplot -A uppmax2020-2-2 --end 2023-05-03 --days 30
213
213
Use ` --start ` and ` --end ` combined to specify a custom range
214
214
of dates for your plot:
215
215
216
- ```
216
+ ``` bash
217
217
projplot -A [project_code] --start [starting_date_in_yyyy-mm-dd_format] --end [ending_date_in_yyyy-mm-dd_format]
218
218
```
219
219
220
220
For example:
221
221
222
- ```
222
+ ``` bash
223
223
projplot -A uppmax2020-2-2 --start 2022-05-03 --end 2023-05-03
224
224
```
225
225
@@ -231,13 +231,13 @@ By default, the current cluster is used.
231
231
Since the different clusters at UPPMAX have separate core hour quotas,
232
232
it makes sense to being able to plot them separately.
233
233
234
- ```
234
+ ``` bash
235
235
projplot -A [project_code] -c [cluster_name]
236
236
```
237
237
238
238
For example:
239
239
240
- ```
240
+ ``` bash
241
241
projplot -A uppmax2020-2-2 -c snowy
242
242
```
243
243
@@ -247,7 +247,7 @@ Valid cluster names are `bianca`, `rackham` and `snowy`.
247
247
248
248
Use `projplot` with a nonsense clustername:
249
249
250
- ```
250
+ ```bash
251
251
projplot -A uppmax2020-2-2 --cluster nonsensename
252
252
```
253
253
@@ -266,12 +266,12 @@ By giving `--no-running-jobs` when running `projplot`,
266
266
it skips checking the queue and if you do have jobs running,
267
267
they will not be visible in the plot or in the sum of core hours used.
268
268
269
- ```
269
+ ``` bash
270
270
projplot -A [project_code] --no-running-jobs
271
271
```
272
272
273
273
For example:
274
274
275
- ```
275
+ ``` bash
276
276
projplot -A uppmax2020-2-2 --no-running-jobs
277
277
```
0 commit comments