Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 27029a2

Browse files
committedMay 15, 2024
Fix markdown style issues
1 parent 03391bb commit 27029a2

File tree

2 files changed

+26
-25
lines changed

2 files changed

+26
-25
lines changed
 

‎docs/software/projplot.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
11
# `projplot`
22

3-
![](./img/projplot_regular_use.png)
3+
![Projplot plot](./img/projplot_regular_use.png)
44

55
`projplot` is an UPPMAX tool to plot your core hour usage
66

77
## Minimal use
88

99
`projplot` needs only the project code:
1010

11-
```
11+
```bash
1212
projplot -A [project_code]
1313
```
1414

1515
For example:
1616

17-
```
17+
```bash
1818
projplot -A uppmax2020-2-2
1919
```
2020

2121
Output will look similar to this:
2222

23-
![](./img/projplot_regular_use.png)
23+
![A projplot plot](./img/projplot_regular_use.png)
2424

2525
> Example `projplot` output. The horizontal axis
2626
> shows the days before today, the vertical axis shows
@@ -57,7 +57,7 @@ your get those core hours back to the project.
5757
If we look at a project that has used more core hours than their projects allocation,
5858
the image will look like this:
5959

60-
![](./img/projplot_over_quota.png)
60+
![A projplot that is over quota](./img/projplot_over_quota.png)
6161

6262
There is a message about the core hour limit being reached at the top of the plot.
6363
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.
7575

7676
`projplot` has more options, that are shown by using `--help`:
7777

78-
```
78+
```bash
7979
projplot --help
8080
```
8181

@@ -85,7 +85,7 @@ Below, these options are discussed in detail.
8585

8686
Use `--help` (or `-h`) to get a short description of the options and some examples:
8787

88-
```
88+
```bash
8989
projplot --help
9090
```
9191

@@ -149,14 +149,14 @@ projplot --help
149149
Use `--days` (or `-d`) the plot a custom number of days,
150150
instead of the default of 30 days:
151151

152-
```
152+
```bash
153153
projplot -A [project_code] --days [number_of_days]
154154
```
155155

156156
For example, this will plot the last 45 days:
157157
:
158158

159-
```
159+
```bash
160160
projplot -A uppmax2020-2-2 --days 45
161161
```
162162

@@ -165,13 +165,13 @@ projplot -A uppmax2020-2-2 --days 45
165165
Use `--start` (or `-s`) to specify a custom starting date,
166166
from when the time in your plot will start:
167167

168-
```
168+
```bash
169169
projplot -A [project_code] --start [starting_date_in_yyyy-mm-dd_format]
170170
```
171171

172172
For example:
173173

174-
```
174+
```bash
175175
projplot -A uppmax2020-2-2 --start 2023-05-03
176176
```
177177

@@ -180,7 +180,7 @@ and the default number of days after that date.
180180
The command below does exactly the same, yet makes the default
181181
number of days explicit:
182182

183-
```
183+
```bash
184184
projplot -A uppmax2020-2-2 --start 2023-05-03 --days 30
185185
```
186186

@@ -189,13 +189,13 @@ projplot -A uppmax2020-2-2 --start 2023-05-03 --days 30
189189
Use `--end` (or `-e`) to specify a custom ending date,
190190
from when the time in your plot will end:
191191

192-
```
192+
```bash
193193
projplot -A [project_code] --end [ending_date_in_yyyy-mm-dd_format]
194194
```
195195

196196
For example:
197197

198-
```
198+
```bash
199199
projplot -A uppmax2020-2-2 --end 2023-05-03
200200
```
201201

@@ -204,7 +204,7 @@ and the default number of days before that date.
204204
The command below does exactly the same, yet makes the default
205205
number of days explicit:
206206

207-
```
207+
```bash
208208
projplot -A uppmax2020-2-2 --end 2023-05-03 --days 30
209209
```
210210

@@ -213,13 +213,13 @@ projplot -A uppmax2020-2-2 --end 2023-05-03 --days 30
213213
Use `--start` and `--end` combined to specify a custom range
214214
of dates for your plot:
215215

216-
```
216+
```bash
217217
projplot -A [project_code] --start [starting_date_in_yyyy-mm-dd_format] --end [ending_date_in_yyyy-mm-dd_format]
218218
```
219219

220220
For example:
221221

222-
```
222+
```bash
223223
projplot -A uppmax2020-2-2 --start 2022-05-03 --end 2023-05-03
224224
```
225225

@@ -231,13 +231,13 @@ By default, the current cluster is used.
231231
Since the different clusters at UPPMAX have separate core hour quotas,
232232
it makes sense to being able to plot them separately.
233233

234-
```
234+
```bash
235235
projplot -A [project_code] -c [cluster_name]
236236
```
237237

238238
For example:
239239

240-
```
240+
```bash
241241
projplot -A uppmax2020-2-2 -c snowy
242242
```
243243

@@ -247,7 +247,7 @@ Valid cluster names are `bianca`, `rackham` and `snowy`.
247247

248248
Use `projplot` with a nonsense clustername:
249249

250-
```
250+
```bash
251251
projplot -A uppmax2020-2-2 --cluster nonsensename
252252
```
253253

@@ -266,12 +266,12 @@ By giving `--no-running-jobs` when running `projplot`,
266266
it skips checking the queue and if you do have jobs running,
267267
they will not be visible in the plot or in the sum of core hours used.
268268

269-
```
269+
```bash
270270
projplot -A [project_code] --no-running-jobs
271271
```
272272

273273
For example:
274274

275-
```
275+
```bash
276276
projplot -A uppmax2020-2-2 --no-running-jobs
277277
```

‎docs/software/python_install_packages.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This page described how to install [Python](python.md) packages.
44

55
There are many ways to install a [Python](python.md) package:
66

7-
- [Using `setup.py`](#using-setup.py)
7+
- Using `setup.py`
88
- using a Python package installer
99
- **PyPI** using [`pip`](#pip)
1010
- **Conda** using [`conda`](#conda)
@@ -13,6 +13,7 @@ You may want to [check if a package is already installed](#check-if-a-package-is
1313

1414
[The Python package installers are compared](#comparison-between-conda-and-pypi)
1515
after which each is discussed:
16+
1617
- **PyPI** using [`pip`](#pip)
1718
- **Conda** using [`conda`](#conda)
1819

@@ -24,7 +25,7 @@ There are multiple ways to check if a Python package is installed:
2425

2526
In the terminal, type:
2627

27-
```
28+
```bash
2829
pip list
2930
```
3031

@@ -53,7 +54,7 @@ Python interface.
5354
packages with a Python interface, it is often used to also distribute packages
5455
which do not contain any Python (e.g. C or C++ packages).
5556

56-
Parameter | `conda` | `pip`
57+
Parameter | `conda` | `pip`
5758
-----------------------------|---------|-------
5859
Installs Python packages | Yes | Yes
5960
Installs non-Python software | Yes | No

0 commit comments

Comments
 (0)
Please sign in to comment.