README.md 1.43 KB
Newer Older
1
2
This project tries and test approaches that might lead to an improved architecture for
nomad@FAIR.
3

4
5
6
7
8
9
10
11
12
13
14
15
16
17
## 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
18

19
First, clone this repo:
20
```
21
22
git clone git@gitlab.mpcdf.mpg.de:nomad-lab/nomad-FAIR.git
cd nomad-FAIR
23
24
```

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

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

38
Forth, generate the documentation:
39
```
40
41
cd docs
make html
42
43
```

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