README.md 1.35 KB
Newer Older
1
# User documentation
David Hrbáč's avatar
David Hrbáč committed
2

David Hrbáč's avatar
David Hrbáč committed
3 4 5 6 7 8 9 10 11 12 13 14
This project contains IT4Innovations user documentation source.

## Development

### Install

```console
$ sudo apt install libpython-dev
$ virtualenv venv
$ source venv/bin/activate
$ pip install -r requirements.txt
```
Lukáš Krupčík's avatar
Lukáš Krupčík committed
15

16 17 18 19
### Package upgrade with pip

```console
$ pip list -o
20
$ pip install --upgrade package
21 22 23
$ pip freeze | sed '/pkg-resources==/d' > requirements.txt
```

David Hrbáč's avatar
David Hrbáč committed
24
## Environments
David Hrbáč's avatar
David Hrbáč committed
25

26 27
* [https://docs.it4i.cz - master branch](https://docs.it4i.cz - master branch)
* [https://docs.it4i.cz/devel/$BRANCH_NAME](https://docs.it4i.cz/devel/$BRANCH_NAME) - maps the branches, available only with VPN access
David Hrbáč's avatar
David Hrbáč committed
28

David Hrbáč's avatar
David Hrbáč committed
29 30
## URLs

Lukáš Krupčík's avatar
Lukáš Krupčík committed
31 32
* [http://facelessuser.github.io/pymdown-extensions/](http://facelessuser.github.io/pymdown-extensions/)
* [http://squidfunk.github.io/mkdocs-material/](http://squidfunk.github.io/mkdocs-material/)
David Hrbáč's avatar
David Hrbáč committed
33 34 35 36 37 38 39 40

```
fair-share
InfiniBand
RedHat
CentOS
Mellanox
```
David Hrbáč's avatar
David Hrbáč committed
41

David Hrbáč's avatar
David Hrbáč committed
42
## Mathematical Formulae
David Hrbáč's avatar
David Hrbáč committed
43

Lukáš Krupčík's avatar
Lukáš Krupčík committed
44
### Formulas are made with:
David Hrbáč's avatar
David Hrbáč committed
45

Pavel Gajdušek's avatar
Pavel Gajdušek committed
46 47
* [https://facelessuser.github.io/pymdown-extensions/extensions/arithmatex/](https://facelessuser.github.io/pymdown-extensions/extensions/arithmatex/)
* [https://www.mathjax.org/](https://www.mathjax.org/)
David Hrbáč's avatar
David Hrbáč committed
48 49 50 51 52 53 54 55 56 57

You can add formula to page like this:

```
$$
MAX\_FAIRSHARE * ( 1 - \frac{usage_{Project}}{usage_{Total}} )
$$
```

To enable the MathJX on page you need to enable it by adding line ```---8<--- "mathjax.md"``` at the end of file.