README.md 6.49 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
6
7
8
9
10
11
12
This project implements the new *nomad@FAIRDI* infrastructure. Contrary to its NOMAD CoE
predecessor, it implements the NOMAD Repository and NOMAD Archive functionality within
a single cohesive application. This project provides all necessary artifacts to develop,
test, deploy, and operate the NOMAD Respository and Archive, e.g. at
[https://repository.nomad-coe.eu/app/gui](https://repository.nomad-coe.eu/app/gui).

In the future, this project's aim is to integrate more NOMAD CoE components, like the NOMAD
Encyclopedia and NOMAD Analytics Toolkit, to fully integrate NOMAD with one GUI and consistent
APIs. Furthermore, this projects aims at establishing NOMAD as a distributed platform for
13
14
15
16
17
18
material science data sharing and management. This includes the on-site deployment of
NOMAD as a standalone service (*oasis*), the federated use of NOMAD through a
serious of full and partial *mirrors*, the integration of 3rd party material science
databases (i.e. [Aflow](http://www.aflow.org/), [OQMD](http://oqmd.org/),
[Materials Project](https://materialsproject.org/)), and support for open APIs and
standards like the [Optimade](http://www.optimade.org/) API.
19

20

21
## Getting started
22

Markus Scheidgen's avatar
Markus Scheidgen committed
23
24
25
26
27
28
### Using NOMAD as a Python package

You can install the `nomad` Python package from source distribution with pip. Please
note, that this will only install part of NOMAD's dependencies that will only allow
your to use NOMAD's client library, e.g. to access the NOMAD Archive.
```
29
pip install nomad
Markus Scheidgen's avatar
Markus Scheidgen committed
30
31
32
33
```

To **use the NOMAD parsers for example**, install the `parsing` extra:
```
34
pip install nomad[parsing]
Markus Scheidgen's avatar
Markus Scheidgen committed
35
36
37
38
39
nomad parse --show-backend <your-file-to-parse>
```

### For NOMAD developer

40
41
42
Read the [docs](https://repository.nomad-coe.eu/app/docs). The documentation is also part
of the source code. It covers aspects like introduction, architecture, development setup/deployment,
contributing, and API reference.
43

Markus Scheidgen's avatar
Markus Scheidgen committed
44
45

## Change log
46

Markus Scheidgen's avatar
Markus Scheidgen committed
47
Omitted versions are plain bugfix releases with only minor changes and fixes.
Markus Scheidgen's avatar
Markus Scheidgen committed
48

Markus Scheidgen's avatar
Markus Scheidgen committed
49
50
51
### v0.8.1
- switched to support Python 3.7

52
53
### v0.8.0
- new underlying datamodel that allows to maintain multiple domains
Markus Scheidgen's avatar
Markus Scheidgen committed
54
- multiple domains supported the GUI
55
- new metainfo implementation
56
- API endpoint to access the metainfo
57
58
59
60
- new archive based on new metainfo
- client library that serves archive data as objects (with tab completion) not dictionaries
- properties and user tab in the search GUI
- improved performance on most parsers
Markus Scheidgen's avatar
Markus Scheidgen committed
61
- NOMAD source distribution
62

63
64
65
66
### v0.7.9
- Everything to run a simple NOMAD OASIS based on the central user-management
- minor bugfixes

67
68
69
70
### v0.7.7
- Shows dataset contents with embargo data, but hides the entry details (raw-files, archive)
- minor bugfixes

71
### v0.7.5
Markus Scheidgen's avatar
Markus Scheidgen committed
72
- AFLOWLIB prototypes (archive)
73
74
- primitive label search
- improved search performance based on excluded fields
Markus Scheidgen's avatar
Markus Scheidgen committed
75
- improved logs
76
77
- minor bugfixes

78
79
80
81
82
83
84
85
### v0.7.3
- fixed aborted raw-file downloads
- improved representation of data availability (staging, embargo, public) in GUI
- user data uploads ordered by upload time
- user data shows uploads with name
- configurable embargo period length
- minor bugfixes

86
87
88
89
### v0.7.2
- API curl, Python, and results for entries and search queries shown in the GUI
- minor bugfixes

Markus Scheidgen's avatar
Markus Scheidgen committed
90
91
92
93
### v0.7.1
- Download of archive files based on search queries
- minor bugfixes

Markus Scheidgen's avatar
Markus Scheidgen committed
94
### v0.7.0
95
96
- User metadata editing and datasets with DOIs
- Revised GUI lists (entries, grouped entries, datasets, uploads)
97
- Keycloak based user management
98
99
- Rawfile preview
- no dependencies with the old NOMAD CoE Repository
100
101
102
103
104
105
106

### v0.6.2
- GUI performance enhancements
- API /raw/query endpoint takes file pattern to further filter download contents and
  strips potential shared path prefixes for a cleaner download .zip
- Stipped common path prefixes in raw file downloads
- minor bugfixes
107

108
### v0.6.0
Markus Scheidgen's avatar
Markus Scheidgen committed
109
- GUI URL, and API endpoint that resolves NOMAD CoE legacy PIDs
110
111
- Support for datasets in the GUI
- more flexible search python module and repo API
Markus Scheidgen's avatar
Markus Scheidgen committed
112
- support for external_id
113
- support for code-based raw_id
114
- Optimade API 0.10.0
115
- GUI supports Optimade filter query and other quantities
116
117
- minor bugfixes

118
119
120
121
122
### v0.5.2
- allows to download large files over longer time period
- streamlined deployment without API+GUI proxy
- minor bugfixes

Markus Scheidgen's avatar
Markus Scheidgen committed
123
### v0.5.1
Markus Scheidgen's avatar
Markus Scheidgen committed
124
- integrated parsers Dmol3, qbox, molcas, fleur, and onetep
125
- API endpoint for query based raw file download
Markus Scheidgen's avatar
Markus Scheidgen committed
126
- improvements to admin cli: e.g. clean staging files, reprocess uploads based on codes
127
- improved error handling in the GUI
Markus Scheidgen's avatar
Markus Scheidgen committed
128
- lots of parser bugfixes
Markus Scheidgen's avatar
Markus Scheidgen committed
129
130
- lots of minor bugfixes

131
### v0.5.0
132
133
The first production version of nomad@fairdi as the upload API and gui for NOMAD
- Production ready software and deployments (term agreements, better GUI docs)
134
135
136
- 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.
137
- Search interface that contains all features of the CoE Repository GUI.
138
139
140
- 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).
141
142
143
- reprocessing of published results (e.g. after parser/normalizer improvements)
- mirror functionality
- refactored command line interface (CLI)
144
- potential GUI user tracking capabilities
145
- many minor bugfixes
146

147
148
149
150
### v0.4.7
- more migration scripts
- minor bugfixes

151
152
153
154
155
156
### 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

157
158
159
160
161
### v0.4.5
- improved uploads view with published uploads
- support for publishing to the existing nomad CoE repository
- many minor bugfixes

162
### v0.4.4
163
- improved GUI navigation
164
165
- support for multiple domains
- info API endpoint
Markus Scheidgen's avatar
Markus Scheidgen committed
166
- metainfo browser
Markus Scheidgen's avatar
Markus Scheidgen committed
167
- support for latest exciting version
Markus Scheidgen's avatar
Markus Scheidgen committed
168
- bugfixes in system normalization
Markus Scheidgen's avatar
Markus Scheidgen committed
169
- many minor bugfixes
170

171
172
173
174
175
176
177
### 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
178
179
180
### v0.4.2
- bugfixes regarding the migration
- better migration configurability and reproducibility
Markus Scheidgen's avatar
Markus Scheidgen committed
181
- scales to multi node kubernetes deployment