README.md 1.75 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
9
10
11
12
13
14
15
16
17
18
19
20
## Getting started

Reat the docs. The documentation is part of the source code. It covers aspects like
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:

[http://enc-staging-nomad.esc.rzg.mpg.de/nomad/docs](http://enc-staging-nomad.esc.rzg.mpg.de/nomad/docs)

### Generate the docs from the source
21

22
First, clone this repo:
23
```
24
25
git clone git@gitlab.mpcdf.mpg.de:nomad-lab/nomad-FAIR.git
cd nomad-FAIR
26
27
```

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

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

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

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