Commit 61e50082 authored by Markus Scheidgen's avatar Markus Scheidgen
Browse files

Updated the about information and hide some developer data. #190

parent a0b20b31
window.nomadEnv = {
'apiBase': 'http://localhost:8000/fairdi/nomad/latest/api',
'kibanaBase': '/fairdi/kibana'
'kibanaBase': '/fairdi/kibana',
'debug': false
}
......@@ -2,7 +2,7 @@ import React from 'react'
import PropTypes from 'prop-types'
import { withStyles } from '@material-ui/core/styles'
import Markdown from './Markdown'
import { kibanaBase, apiBase } from '../config'
import { kibanaBase, apiBase, debug } from '../config'
import { compose } from 'recompose'
import { withApi } from './api'
import { withDomain } from './domains'
......@@ -42,25 +42,34 @@ class About extends React.Component {
<Markdown>{`
${domain.about}
### Getting Help
If you encounter any difficulties, please write to
[webmaster@nomad-repository.eu](mailto:webmaster@nomad-repository.eu). If you think
that this web-page does not work as expected, or you want to start a discussion
about possible features, feel free to open an issue on our [issue tracking
system](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-FAIR/issues).
### Developer Documentation
You find in depth developer documentation [here](${apiBase}/docs/index.html).
It contains a general introduction to nomad, the underlying architecture,
is (meta)data, and processing. Learn how to use the nomad ReST API. It
contains information about how to develop nomad, how to operate it, how to
It contains a general introduction to Nomad, the underlying architecture,
is (meta)data, and processing. Learn how to use the Nomad ReST API. It
contains information about how to develop Nomad, how to operate it, how to
contribute parser, and much more.
### ReST API
Nomad services can also be accessed programmatically via nomad's
Nomad services can also be accessed programmatically via Nomad's
ReST API. The API is described via [swagger](https://swagger.io/), therefore
you can use your favorite swagger client library (e.g.
[bravado](https://github.com/Yelp/bravado) for Python).
Here is [our API's swagger UI](${apiBase}/) as reference documentation.
### Source code
The source-code for nomad@FAIRDI is maintained at the MPCDF's
[gitlab](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-FAIR). To push code, you
need an MPCDF account and you can apply [here](https://www.mpcdf.mpg.de/userspace/forms/onlineregistrationform).
The source-code for this new version of Nomad (dubbed *nomad@FAIRDI*) is maintained
at the MPCDF's [gitlab](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-FAIR).
To push code, you need an MPCDF account and you can apply
[here](https://www.mpcdf.mpg.de/userspace/forms/onlineregistrationform).
${debug ? `
### Log management with Elastic stack
We use a central logging system based on the *elastic*-stack
(previously called *Elastic Logstash Kibana* (ELK)-stack).
......@@ -69,11 +78,12 @@ class About extends React.Component {
can be analysed visually. Here is the [link to Kibana](${kibanaBase}/)
### Test user
During development this GUI might not be connected to the actual nomad
During development this GUI might not be connected to the actual Nomad
repository. Therefore, you cannot create a user or login with an existing
user. You might use the test user \`leonard.hofstadter@nomad-fairdi.tests.de\`
with password \`password\`. The user \`sheldon.cooper@nomad-fairdi.tests.de\` is
used for data that has no provenance with the original Nomad CoE database.
` : ''}
### About this version
- version: \`${info ? info.version : 'loading'}/${info ? info.release : 'loading'}\`
......
......@@ -24,51 +24,30 @@ class DomainProviderBase extends React.Component {
DFT: {
name: 'DFT',
about: `
## The nomad**@FAIRDI** (*beta*)
### About nomad@FAIRDI
After the conclusion of the original [NOMAD-coe](http://nomad-coe.eu) project,
the newly founded NGO *FAIR Data Infrastructures* (FAIRDI) provides an
umbrella to continue operation and further development of the Nomad
material science data sharing platform.
The immediate goal is to to consolidate and stabilize the nomad infrastructure, and
as a first step, we refined the Nomad upload and data processing. This GUI introduces
the *staging area* that allows you to observe your uploads processing and inspect
the uploaded data before you decide to either publish your data or delete your upload again.
### About the Nomad upload
Currently this is designed as a complement to the original [Nomad Repository GUI](https://repository.nomad-coe.eu/NomadRepository-1.1).
You upload, process, inspect, and publish your data here. Here you have some
capabilities to search and explore uploaded data. But to add comments, co-authors, and references,
create data-sets, and manage your account you still have to use the original [Nomad Repository GUI](https://repository.nomad-coe.eu/NomadRepository-1.1).
This GUI allows you to (menu on the left):
* About: read about this, access the documentation, and API.
* Search: inspect for existing data, your's and others (currently the search will only changed new data uploaded through nomad@FAIRDI).
* Upload: drop data, view the processing, and publish your uploads.
* Metainfo: browse the *metainfo*, Nomad's (meta-)data schema for processed data.
### How to use the new upload and processing
In the future, this web-page will include more and more features of other Nomad
components as an effort to consolidate the various web applications from the
Nomad Repository, Archive, Metainfo, Encyclopedia, and Analytics Toolkit.
**!Please read this, before you explore this new part of Nomad!**
Feel free to explore this *new* part of Nomad, but expect that not everything will
be working perfectly. Travel through the menu on the left and just
use it. Feel free to upload data, look for limitations and things you do not like.
The goal should be to figure out what is wrong and missing.
Keep in mind that there are limitations:
* You can only login with users that already exist in the Nomad Repository. If you
### Limitations
You can only login with users that already exist in the Nomad Repository. If you
are new to Nomad, visit the [Nomad Repository GUI](https://repository.nomad-coe.eu/NomadRepository-1.1)
or register for a user account [here](http://nomad-repository.eu:8080/NomadRepository-1.1/register/).
* When you published your data here, it will still take a day to index. Therefore,
When you published your data here, it will still take a day to index. Therefore,
your data will not appear in the Nomad Repository immediately.
* The existing entries from the original Nomad do not appear in the search. We
are currently migrating the data. You will be able to see all your data, old and new, soon.
For feedback and any issues you find, feel free to [open an issue](https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-FAIR/issues) or write
an email to [markus.scheidgen@physik.hu-berlin.de](mailto:markus.scheidgen@physik.hu-berlin.de).
We migrated all data from the Nomad Repository to this new system. However, not
all data could be successfully processed by the new and more powerful parsers.
We will continue to improve the parsers to raise the quality of archive data overtime.
For some entries, no archive data might be currently available and some metadata might
still be missing.
`,
entryLabel: 'calculation',
searchPlaceholder: 'enter atoms, codes, functionals, or other quantity values',
......
......@@ -24,7 +24,7 @@ now show all of NOMAD's data. To see the full NOMAD dataset use the original
[NOMAD CoE Repository](https://repository.nomad-coe.eu/NomadRepository-1.1/search/)
for now.
### Search Options
#### Search Options
Nomad's *domain-aware* search allows you to screen data by filtering based on
desired properties. This is different from basic *text-search* that traditional
......@@ -43,7 +43,7 @@ The periodic table and bar-charts show metrics for all data that fit your criter
You can display *entries* (e.g. code runs), *unique entries*, and *datasets*.
Other more specific metrics might be available.
### Search Results
#### Search Results
The results table gives you a quick overview of all entries that fit your search.
You can click entries to see more details, download data, see the archive, etc.
......
......@@ -10,6 +10,7 @@ import ReactJson from 'react-json-view'
import { compose } from 'recompose'
import { withErrors } from '../errors'
import { withRouter } from 'react-router'
import { debug } from '../../config'
class Upload extends React.Component {
static propTypes = {
......@@ -517,10 +518,10 @@ class Upload extends React.Component {
</Typography> : ''
}
{upload.calcs ? this.renderCalcTable() : ''}
<div className={classes.detailsContent}>
<ReactJson src={upload} enableClipboard={false} collapsed={0} />
</div>
{debug
? <div className={classes.detailsContent}>
<ReactJson src={upload} enableClipboard={false} collapsed={0} />
</div> : ''}
</ExpansionPanelDetails>
</ExpansionPanel>
</div>
......
......@@ -25,7 +25,7 @@ Nomad now provides a two step upload process. After you upload your files, you
check nomad's processing of your files before you publish your data. This gives you
more control about how nomad will present your data.
### Prepare and upload files
#### Prepare and upload files
To upload your own data, please put all relevant files of all the calculations
you want to upload into a single \`*.zip\` or \`*.tar.gz\` archive.
......@@ -42,7 +42,7 @@ return here and press the reload button below).
There is a limit of 32 GB per upload. Please upload multiple archives, if
you have more than 32 GB of data to upload.
### The staging area
#### The staging area
Uploaded data will not be public immediately. We call this *staging area*.
......@@ -63,6 +63,13 @@ During an *embargo* some meta-data will be available.
When you published your upload, it will take a night before it will appear in the
[Nomad Repository](https://repository.nomad-coe.eu/NomadRepository-1.1/).
We are working on improving this process.
#### Co-Authors, References, Comments, Datasets
Currently, this web-page is only about uploading your calculations. To further edit
comments, references, co-authors, share with other authors, or curate datasets, use
the [Nomad Repository](https://repository.nomad-coe.eu/NomadRepository-1.1/) on
your published data (as usual).
`
class Uploads extends React.Component {
......
......@@ -9,6 +9,7 @@ window.nomadEnv = window.nomadEnv || {}
export const apiBase = window.nomadEnv.apiBase
export const appBase = process.env.PUBLIC_URL
export const kibanaBase = window.nomadEnv.kibanaBase
export const debug = window.nomadEnv.debug || false
export const repoPrimaryColor = repo
......
......@@ -7,6 +7,9 @@ proxy:
api:
disableReset: false
gui:
debug: true
worker:
replicas: 3
routing: "worker"
......
......@@ -7,6 +7,9 @@ proxy:
api:
disableReset: false
gui:
debug: true
worker:
replicas: 1
routing: "queue"
......
......@@ -7,6 +7,9 @@ proxy:
api:
disableReset: false
gui:
debug: true
worker:
replicas: 1
routing: "queue"
......
......@@ -27,7 +27,8 @@ data:
env.js: |
window.nomadEnv = {
"apiBase": "{{ .Values.proxy.external.path }}/api",
"kibanaBase": "{{ .Values.proxy.external.kibanaPath }}"
"kibanaBase": "{{ .Values.proxy.external.kibanaPath }}",
"debug": {{ .Values.gui.debug }}
};
---
apiVersion: apps/v1
......
......@@ -61,6 +61,8 @@ gui:
replicas: 1
## This port is hard coded into the frontend image, it cannot be really changed
port: 8080
## This variable is used in the GUI to show or hide additional information
debug: false
## Everything concerning the proxy that combined gui, api, kibana
# It is run via NodePort service
......
Supports Markdown
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