README.md 886 Bytes
Newer Older
1
2
This project tries and test approaches that might lead to an improved architecture for NOMAD (XT).

3
## Generate the docs (and continue there)
4

5
First, clone this repo:
6
```
7
8
git clone git@gitlab.mpcdf.mpg.de:mscheidg/nomad-xt.git
cd nomad-xt
9
10
```

11
Second, create and source your own virtual python environment:
12
```
13
pip install virtualenv
14
virtualenv -p `which python3` .pyenv
15
source .pyenv/bin/activate
16
17
```

18
19
Third, install the development dependencies, including the documentation system
[sphinx](http://www.sphinx-doc.org/en/master/index.html):
20
```
21
pip install -r requirements-dev.txt
22
23
```

24
Forth, generate the documentation:
25
```
26
27
cd docs
make html
28
29
```

30
Conintue with reading the documentation for further setup and contribution guidelines:
31
```
32
cd .build/html
33
python -m http.server 8888
34
```
35
36
Open [http://localhost:8888/html/setup.html](http://localhost:8888/html/setup.html) in
your browser.