README.md 7.6 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
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
8
[https://nomad-lab.eu](https://nomad-lab.eu).
9 10 11 12

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-lab
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-lab[parsing]
Markus Scheidgen's avatar
Markus Scheidgen committed
35
nomad parse --show-archive <your-file-to-parse>
Markus Scheidgen's avatar
Markus Scheidgen committed
36 37 38 39
```

### For NOMAD developer

40
Read the [docs](https://nomad-lab.eu/prod/rae/docs/index.html). The documentation is also part
41 42
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

49 50 51 52
### v0.9.9
- A rdf-API that provides dcat datasets and catalog for NOMAD entries.
- Support to directly publish upon upload via API.

53 54
### v0.9.8
- A new library for parsing text-based raw files.
Markus Scheidgen's avatar
Markus Scheidgen committed
55
- A new main menu in the GUI.
56
- Upload OASIS uploads to central NOMAD.
Markus Scheidgen's avatar
Markus Scheidgen committed
57
- Updated documentation.
58

Markus Scheidgen's avatar
Markus Scheidgen committed
59 60 61
### v0.9.3
- Encyclopedia with dedicated materials search index.

62
### v0.9.0
63 64 65 66 67 68 69 70 71 72
- The encyclopedia runs on top of the new infrastructure. The GUIs are integrated via
  bi-lateral navigation between entries.
- The parsers have new documentation and development instructions and can be easily developed
  based on NOMAD's PyPi package nomad-lab
- We introduce workflow metadata (starting with geometry optimizations). This includes search
  for workflow parameter, and 3-tiered archive storage for quick access to results for analytics.
- A new GUI to browse  the Archive and Metainfo
- The Artificial Intelligence Toolkit (at least its tutorial page) is part of the GUI
- The OASIS comprises Repository, Archive, Metainfo, Encyclopedia, and Artificial Intelligence Toolkit.

73 74 75
### v0.8.7
- a new variant of the Metainfo browser

Markus Scheidgen's avatar
Markus Scheidgen committed
76 77
### v0.8.1
- switched to support Python 3.7
78
- client library as pypi package `nomad-lab`
Markus Scheidgen's avatar
Markus Scheidgen committed
79

80 81
### v0.8.0
- new underlying datamodel that allows to maintain multiple domains
Markus Scheidgen's avatar
Markus Scheidgen committed
82
- multiple domains supported the GUI
83
- new metainfo implementation
84
- API endpoint to access the metainfo
85 86 87 88
- 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
89
- NOMAD source distribution
90

91 92 93 94
### v0.7.9
- Everything to run a simple NOMAD OASIS based on the central user-management
- minor bugfixes

95 96 97 98
### v0.7.7
- Shows dataset contents with embargo data, but hides the entry details (raw-files, archive)
- minor bugfixes

99
### v0.7.5
Markus Scheidgen's avatar
Markus Scheidgen committed
100
- AFLOWLIB prototypes (archive)
101 102
- primitive label search
- improved search performance based on excluded fields
Markus Scheidgen's avatar
Markus Scheidgen committed
103
- improved logs
104 105
- minor bugfixes

106 107 108 109 110 111 112 113
### 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

114 115 116 117
### 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
118 119 120 121
### v0.7.1
- Download of archive files based on search queries
- minor bugfixes

Markus Scheidgen's avatar
Markus Scheidgen committed
122
### v0.7.0
123 124
- User metadata editing and datasets with DOIs
- Revised GUI lists (entries, grouped entries, datasets, uploads)
125
- Keycloak based user management
126 127
- Rawfile preview
- no dependencies with the old NOMAD CoE Repository
128 129 130 131 132 133 134

### 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
135

136
### v0.6.0
Markus Scheidgen's avatar
Markus Scheidgen committed
137
- GUI URL, and API endpoint that resolves NOMAD CoE legacy PIDs
138 139
- Support for datasets in the GUI
- more flexible search python module and repo API
Markus Scheidgen's avatar
Markus Scheidgen committed
140
- support for external_id
141
- support for code-based raw_id
142
- Optimade API 0.10.0
143
- GUI supports Optimade filter query and other quantities
144 145
- minor bugfixes

146 147 148 149 150
### 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
151
### v0.5.1
Markus Scheidgen's avatar
Markus Scheidgen committed
152
- integrated parsers Dmol3, qbox, molcas, fleur, and onetep
153
- API endpoint for query based raw file download
Markus Scheidgen's avatar
Markus Scheidgen committed
154
- improvements to admin cli: e.g. clean staging files, reprocess uploads based on codes
155
- improved error handling in the GUI
Markus Scheidgen's avatar
Markus Scheidgen committed
156
- lots of parser bugfixes
Markus Scheidgen's avatar
Markus Scheidgen committed
157 158
- lots of minor bugfixes

159
### v0.5.0
160 161
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)
162 163 164
- 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.
165
- Search interface that contains all features of the CoE Repository GUI.
166 167 168
- 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).
169 170 171
- reprocessing of published results (e.g. after parser/normalizer improvements)
- mirror functionality
- refactored command line interface (CLI)
172
- potential GUI user tracking capabilities
173
- many minor bugfixes
174

175 176 177 178
### v0.4.7
- more migration scripts
- minor bugfixes

179 180 181 182 183 184
### 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

185 186 187 188 189
### v0.4.5
- improved uploads view with published uploads
- support for publishing to the existing nomad CoE repository
- many minor bugfixes

190
### v0.4.4
191
- improved GUI navigation
192 193
- support for multiple domains
- info API endpoint
Markus Scheidgen's avatar
Markus Scheidgen committed
194
- metainfo browser
Markus Scheidgen's avatar
Markus Scheidgen committed
195
- support for latest exciting version
Markus Scheidgen's avatar
Markus Scheidgen committed
196
- bugfixes in system normalization
Markus Scheidgen's avatar
Markus Scheidgen committed
197
- many minor bugfixes
198

199 200 201 202 203 204 205
### 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
206 207 208
### v0.4.2
- bugfixes regarding the migration
- better migration configurability and reproducibility
Markus Scheidgen's avatar
Markus Scheidgen committed
209
- scales to multi node kubernetes deployment