README.md 3.36 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
```
39
40
pip install --upgrade pip
pip install --upgrade setuptools
Markus Scheidgen's avatar
Markus Scheidgen committed
41
pip install -r requirements.txt
42
43
```

44
Forth, generate the documentation:
45
```
46
47
cd docs
make html
48
49
```

50
Conintue with reading the documentation for further setup and contribution guidelines:
51
```
52
cd .build/html
53
python -m http.server 8888
54
```
55
56
Open [http://localhost:8888/html/setup.html](http://localhost:8888/html/setup.html) in
your browser.
Markus Scheidgen's avatar
Markus Scheidgen committed
57
58
59

## Change log

60
61
62
63
### v0.5.0
- Raw file API with support to list directories. This replaces the `files` calculation
  metadata key. It was necessary due to arbitrary large lists of *auxfiles* in some
  calculations.
64
65
66
- Refactored search API that allows to search for entries (paginated + scroll),
  metrics based on quantity aggregations (+ paginated entries), quantity aggregations
  with all values via `after` key (+ paginated entries).
67
68
69
70
- reprocessing of published results (e.g. after parser/normalizer improvements)
- mirror functionality
- refactored command line interface (CLI)
- many minor bugfixes
71

72
73
74
75
### v0.4.7
- more migration scripts
- minor bugfixes

76
77
78
79
80
81
### v0.4.6
- admin commands to directly manipulate upload data
- additional migration scripts
- fixed system normalizer to understand indexed atom labels correctly
- many minor bugfixes

82
83
84
85
86
### v0.4.5
- improved uploads view with published uploads
- support for publishing to the existing nomad CoE repository
- many minor bugfixes

87
### v0.4.4
88
- improved GUI navigation
89
90
- support for multiple domains
- info API endpoint
Markus Scheidgen's avatar
Markus Scheidgen committed
91
- metainfo browser
Markus Scheidgen's avatar
Markus Scheidgen committed
92
- support for latest exciting version
Markus Scheidgen's avatar
Markus Scheidgen committed
93
- bugfixes in system normalization
Markus Scheidgen's avatar
Markus Scheidgen committed
94
- many minor bugfixes
95

96
97
98
99
100
101
102
### v0.4.3
- more flexible celery routing
- config via nomad.yml
- repo_db can be disabled
- publishing of calculations with failed processing
- cli for managing running processing tasks

Markus Scheidgen's avatar
Markus Scheidgen committed
103
104
105
### v0.4.2
- bugfixes regarding the migration
- better migration configurability and reproducibility
Markus Scheidgen's avatar
Markus Scheidgen committed
106
- scales to multi node kubernetes deployment