Commit 5f83003b authored by Markus Scheidgen's avatar Markus Scheidgen
Browse files

Updated README and gitignore.

parent eaff1d8a
.DS_Store .DS_Store
.pyenv/ .*env/
.env/ .python-version
.ipynb_checkpoints/ .ipynb_checkpoints/
__pycache__ __pycache__
.mypy_cache .mypy_cache
......
[![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) [![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) [![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)
This project implements the new *nomad@FAIRDI* infrastructure. It is currently used This project implements the new *nomad@FAIRDI* infrastructure. Contrary to its NOMAD CoE
to enable users to upload data, process the data, maintain a version of the NOMAD predecessor, it implements the NOMAD Repository and NOMAD Archive functionality within
archive and meta-info, provide search, inspection, and download to all NOMAD raw and a single cohesive application. This project provides all necessary artifacts to develop,
archive data. As a long term strategy, this project will integrate, refactor, and re-write test, deploy, and operate the NOMAD Respository and Archive, e.g. at
more and more of the existing NOMAD CoE components. [https://repository.nomad-coe.eu/app/gui](https://repository.nomad-coe.eu/app/gui).
The overall goal of *nomad@FAIRDI* is to provide common interfaces to the main services of NOMAD: In the future, this project's aim is to integrate more NOMAD CoE components, like the NOMAD
*Repository*, *Archive*, and *Encyclopedia*. These interfaces comprise a graphical web-based Encyclopedia and NOMAD Analytics Toolkit, to fully integrate NOMAD with one GUI and consistent
UI that allows users to upload data, supervise data processing, inspect and download APIs. Furthermore, this projects aims at establishing NOMAD as a distributed platform for
metadata, raw-files, and archive data, provide visual tools to explore the data, and
to learn more about advanced use modes, like API and Analytics Toolkit. The second interface
is a unified REST API with various endpoints that represent the core NOMAD services.
This will allow users the automated use of NOMAD for managing their data, and using
data on NOMAD for analytics. A specific way of using the API is through the NOMAD
Analytics Toolkit, which is revamped as a
[separate project](https://gitlab.mpcdf.mpg.de/nomad-lab/analytics-jupyterhub).
Furthermore, this projects aims at establishing NOMAD as a distributed platform for
material science data sharing and management. This includes the on-site deployment of 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 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 serious of full and partial *mirrors*, the integration of 3rd party material science
...@@ -26,56 +17,16 @@ databases (i.e. [Aflow](http://www.aflow.org/), [OQMD](http://oqmd.org/), ...@@ -26,56 +17,16 @@ databases (i.e. [Aflow](http://www.aflow.org/), [OQMD](http://oqmd.org/),
[Materials Project](https://materialsproject.org/)), and support for open APIs and [Materials Project](https://materialsproject.org/)), and support for open APIs and
standards like the [Optimade](http://www.optimade.org/) API. standards like the [Optimade](http://www.optimade.org/) API.
## Getting started ## Getting started
Read the docs. The documentation is part of the source code. It covers aspects like Read the [docs](https://repository.nomad-coe.eu/app/docs). The documentation is also part
introduction, architecture, development setup/deployment, contributing, and API reference. 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
You can access the running system and its documentation here:
[https://repository.nomad-coe.eu/uploads/api/docs](https://repository.nomad-coe.eu/uploads/api/docs/index.html)
### Generate the docs from the source
First, clone this repo and init its submodules:
```
git clone git@gitlab.mpcdf.mpg.de:nomad-lab/nomad-FAIR.git
cd nomad-FAIR
git submodule init --depth 1
```
Second, create and source your own virtual python environment:
```
pip install virtualenv
virtualenv -p `which python3` .pyenv
source .pyenv/bin/activate
```
Third, install the development dependencies, including the documentation system
[sphinx](http://www.sphinx-doc.org/en/master/index.html):
```
pip install --upgrade pip
pip install --upgrade setuptools
pip install -r requirements.txt
```
Forth, generate the documentation:
```
cd docs
make html
```
Conintue with reading the documentation for further setup and contribution guidelines:
```
cd .build/html
python -m http.server 8888
```
Open [http://localhost:8888/html/setup.html](http://localhost:8888/html/setup.html) in
your browser.
## Change log ## Change log
Omitted versions are plain bugfix releases with only minor changes and fixes. Omitted versions are plain bugfix releases with only minor changes and fixes.
### v0.7.1 ### v0.7.1
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment