README.md 1.81 KB
Newer Older
Markus Scheidgen's avatar
Markus Scheidgen committed
1
2
3
[![pipeline status](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-FAIR/badges/master/pipeline.svg)](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-FAIR/commits/master)
[![coverage report](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-FAIR/badges/master/coverage.svg)](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-FAIR/commits/master)

4
5
This project tries and test approaches that might lead to an improved architecture for
nomad@FAIR.
6

7
8
## Getting started

Markus Scheidgen's avatar
Markus Scheidgen committed
9
Read the docs. The documentation is part of the source code. It covers aspects like
10
11
12
13
14
15
16
17
introduction, architecture, development setup/deployment, contributing, and API reference.

### Read the docs on the latest deployed version

Currently, there is only a *staging* version running at garching. There is
no real production system yet. You have to expect frequent down times and restarts.
You can access the running system and its documentation here:

Daniel Speckhard's avatar
Daniel Speckhard committed
18
[http://enc-staging-nomad.esc.rzg.mpg.de/nomad/docs](http://enc-staging-nomad.esc.rzg.mpg.de/fairdi/nomad/v0.3.0/docs)
19
20

### Generate the docs from the source
21

22
First, clone this repo and init its submodules:
23
```
24
25
git clone git@gitlab.mpcdf.mpg.de:nomad-lab/nomad-FAIR.git
cd nomad-FAIR
26
git submodules init --depth 1
27
28
```

29
Second, create and source your own virtual python environment:
30
```
31
pip install virtualenv
32
virtualenv -p `which python3` .pyenv
33
source .pyenv/bin/activate
34
35
```

36
37
Third, install the development dependencies, including the documentation system
[sphinx](http://www.sphinx-doc.org/en/master/index.html):
38
```
Markus Scheidgen's avatar
Markus Scheidgen committed
39
pip install -r requirements.txt
40
41
```

42
Forth, generate the documentation:
43
```
44
45
cd docs
make html
46
47
```

48
Conintue with reading the documentation for further setup and contribution guidelines:
49
```
50
cd .build/html
51
python -m http.server 8888
52
```
53
54
Open [http://localhost:8888/html/setup.html](http://localhost:8888/html/setup.html) in
your browser.