Commit 9e9556a2 authored by Markus Scheidgen's avatar Markus Scheidgen
Browse files

Consitent naming of 'NOMAD'. #190

parent 61e50082
...@@ -33,7 +33,7 @@ ...@@ -33,7 +33,7 @@
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto+Mono:400,500"> <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto+Mono:400,500">
<!-- icon fonts for the meta-info browser --> <!-- icon fonts for the meta-info browser -->
<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons"> <link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
<title>nomad@FAIR</title> <title>NOMAD upload</title>
</head> </head>
<body> <body>
<noscript> <noscript>
......
...@@ -51,20 +51,20 @@ class About extends React.Component { ...@@ -51,20 +51,20 @@ class About extends React.Component {
### Developer Documentation ### Developer Documentation
You find in depth developer documentation [here](${apiBase}/docs/index.html). You find in depth developer documentation [here](${apiBase}/docs/index.html).
It contains a general introduction to Nomad, the underlying architecture, It contains a general introduction to NOMAD, the underlying architecture,
is (meta)data, and processing. Learn how to use the Nomad ReST API. It 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 contains information about how to develop NOMAD, how to operate it, how to
contribute parser, and much more. contribute parser, and much more.
### ReST API ### 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 ReST API. The API is described via [swagger](https://swagger.io/), therefore
you can use your favorite swagger client library (e.g. you can use your favorite swagger client library (e.g.
[bravado](https://github.com/Yelp/bravado) for Python). [bravado](https://github.com/Yelp/bravado) for Python).
Here is [our API's swagger UI](${apiBase}/) as reference documentation. Here is [our API's swagger UI](${apiBase}/) as reference documentation.
### Source code ### Source code
The source-code for this new version of Nomad (dubbed *nomad@FAIRDI*) is maintained 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). 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 To push code, you need an MPCDF account and you can apply
[here](https://www.mpcdf.mpg.de/userspace/forms/onlineregistrationform). [here](https://www.mpcdf.mpg.de/userspace/forms/onlineregistrationform).
...@@ -78,11 +78,11 @@ class About extends React.Component { ...@@ -78,11 +78,11 @@ class About extends React.Component {
can be analysed visually. Here is the [link to Kibana](${kibanaBase}/) can be analysed visually. Here is the [link to Kibana](${kibanaBase}/)
### Test user ### 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 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\` 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 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. used for data that has no provenance with the original NOMAD CoE database.
` : ''} ` : ''}
### About this version ### About this version
......
...@@ -35,7 +35,7 @@ const toolbarTitles = { ...@@ -35,7 +35,7 @@ const toolbarTitles = {
'/': 'About, Documentation, Getting Help', '/': 'About, Documentation, Getting Help',
'/search': 'Find and Download Data', '/search': 'Find and Download Data',
'/uploads': 'Upload and Publish Data', '/uploads': 'Upload and Publish Data',
'/metainfo': 'The Nomad Meta Info' '/metainfo': 'The NOMAD Meta Info'
} }
const toolbarThemes = { const toolbarThemes = {
...@@ -49,7 +49,7 @@ const toolbarHelp = { ...@@ -49,7 +49,7 @@ const toolbarHelp = {
'/': null, '/': null,
'/search': {title: 'How to find and download data', content: searchHelp}, '/search': {title: 'How to find and download data', content: searchHelp},
'/uploads': {title: 'How to upload data', content: uploadHelp}, '/uploads': {title: 'How to upload data', content: uploadHelp},
'/metainfo': {title: 'About the Nomad meta-info', content: metainfoHelp} '/metainfo': {title: 'About the NOMAD meta-info', content: metainfoHelp}
} }
class NavigationUnstyled extends React.Component { class NavigationUnstyled extends React.Component {
......
...@@ -133,7 +133,7 @@ class LoginLogout extends React.Component { ...@@ -133,7 +133,7 @@ class LoginLogout extends React.Component {
<DialogContent> <DialogContent>
<DialogContentText> <DialogContentText>
To login, please enter your email address and password. If you To login, please enter your email address and password. If you
do not have an account, please go to the nomad repository and do not have an account, please go to the NOMAD Repository and
create one. create one.
</DialogContentText> </DialogContentText>
{failure ? <DialogContentText className={classes.errorText} color="error">Wrong username or password!</DialogContentText> : ''} {failure ? <DialogContentText className={classes.errorText} color="error">Wrong username or password!</DialogContentText> : ''}
......
...@@ -481,7 +481,7 @@ class LoginRequiredUnstyled extends React.Component { ...@@ -481,7 +481,7 @@ class LoginRequiredUnstyled extends React.Component {
let loginMessage = '' let loginMessage = ''
if (message) { if (message) {
loginMessage = <Typography> loginMessage = <Typography>
{this.props.message} If you do not have a Nomad Repository account, register <Link href='http://nomad-repository.eu:8080/NomadRepository-1.1/register/'>here</Link>. {this.props.message} If you do not have a NOMAD Repository account, register <Link href='http://nomad-repository.eu:8080/NomadRepository-1.1/register/'>here</Link>.
</Typography> </Typography>
} }
......
...@@ -24,26 +24,26 @@ class DomainProviderBase extends React.Component { ...@@ -24,26 +24,26 @@ class DomainProviderBase extends React.Component {
DFT: { DFT: {
name: 'DFT', name: 'DFT',
about: ` about: `
### About the Nomad upload ### 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). 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 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, 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). 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).
In the future, this web-page will include more and more features of other Nomad 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 components as an effort to consolidate the various web applications from the
Nomad Repository, Archive, Metainfo, Encyclopedia, and Analytics Toolkit. NOMAD Repository, Archive, Metainfo, Encyclopedia, and Analytics Toolkit.
### Limitations ### Limitations
You can only login with users that already exist in the Nomad Repository. If you 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) 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/). 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. your data will not appear in the NOMAD Repository immediately.
We migrated all data from the Nomad Repository to this new system. However, not 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. 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. 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 For some entries, no archive data might be currently available and some metadata might
...@@ -137,10 +137,10 @@ class DomainProviderBase extends React.Component { ...@@ -137,10 +137,10 @@ class DomainProviderBase extends React.Component {
The original goal of the NOMAD CoE project was to provide a data sharing and The original goal of the NOMAD CoE project was to provide a data sharing and
publication platform for computational material science data. With this prototype, publication platform for computational material science data. With this prototype,
we want to apply Nomad ideas and implementations to experimental material science we want to apply NOMAD ideas and implementations to experimental material science
data. data.
As a first step, this site demonstrates Nomad's \`domain specific\` search interface As a first step, this site demonstrates NOMAD's \`domain specific\` search interface
and how experiment (meta-)data can be represented. We want to explore what and how experiment (meta-)data can be represented. We want to explore what
meta-data exists for material experiments, what is necessary to provide meaningful meta-data exists for material experiments, what is necessary to provide meaningful
search capabilities, how we can implement FAIR data sharing principles, and search capabilities, how we can implement FAIR data sharing principles, and
......
...@@ -12,13 +12,13 @@ import { ValueAttributes, MetaAttribute } from '../metaInfoBrowser/ValueCard' ...@@ -12,13 +12,13 @@ import { ValueAttributes, MetaAttribute } from '../metaInfoBrowser/ValueCard'
import ApiDialogButton from '../ApiDialogButton' import ApiDialogButton from '../ApiDialogButton'
export const help = ` export const help = `
The nomad **archive** provides data and meta-data in a common hierarchical format based on The NOMAD **archive** provides data and meta-data in a common hierarchical format based on
well-defined quantity definitions that we call *metainfo*. This representation well-defined quantity definitions that we call *metainfo*. This representation
is independent from the raw data format and provides a homogenous data stock. is independent from the raw data format and provides a homogenous data stock.
You can click the various quantity values to see the quantity definition. Similarly, You can click the various quantity values to see the quantity definition. Similarly,
you can click section names to get more information. Browse the *metainfo* to you can click section names to get more information. Browse the *metainfo* to
learn more about nomad's archive format [here](/metainfo). learn more about NOMAD's archive format [here](/metainfo).
` `
class ArchiveEntryView extends React.Component { class ArchiveEntryView extends React.Component {
......
...@@ -10,11 +10,11 @@ import { compose } from 'recompose' ...@@ -10,11 +10,11 @@ import { compose } from 'recompose'
import { schema } from '../MetaInfoRepository' import { schema } from '../MetaInfoRepository'
export const help = ` export const help = `
The nomad *metainfo* defines all quantities used to represent archive data in The NOMAD *metainfo* defines all quantities used to represent archive data in
nomad. You could say it is the archive *schema*. You can browse this schema and NOMAD. You could say it is the archive *schema*. You can browse this schema and
all its definitions here. all its definitions here.
The nomad metainfo knows three different *kinds* of definitions: The NOMAD metainfo knows three different *kinds* of definitions:
- **sections**: A section are nested groups of quantities that allow a hierarchical data structure - **sections**: A section are nested groups of quantities that allow a hierarchical data structure
- **values**: Actual quantities that contain data - **values**: Actual quantities that contain data
......
...@@ -15,7 +15,7 @@ import { withDomain } from '../domains' ...@@ -15,7 +15,7 @@ import { withDomain } from '../domains'
import { appBase } from '../../config' import { appBase } from '../../config'
export const help = ` export const help = `
This page allows you to **search** in nomad's data. The upper part of this page This page allows you to **search** in NOMAD's data. The upper part of this page
gives you various options to enter and configure your search. The lower half gives you various options to enter and configure your search. The lower half
shows all data that fulfills your search criteria. shows all data that fulfills your search criteria.
...@@ -26,7 +26,7 @@ for now. ...@@ -26,7 +26,7 @@ for now.
#### Search Options #### Search Options
Nomad's *domain-aware* search allows you to screen data by filtering based on 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 desired properties. This is different from basic *text-search* that traditional
search engines offer. search engines offer.
...@@ -49,7 +49,7 @@ The results table gives you a quick overview of all entries that fit your search ...@@ -49,7 +49,7 @@ 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. You can click entries to see more details, download data, see the archive, etc.
The *raw files* tab, will show you all files that belong to the entry and offers a download The *raw files* tab, will show you all files that belong to the entry and offers a download
on individual, or all files. The *archive* tab, shows you the parsed data as a tree on individual, or all files. The *archive* tab, shows you the parsed data as a tree
data structure. This view is connected to Nomad's [meta-info](${appBase}/metainfo), which acts a schema for data structure. This view is connected to NOMAD's [meta-info](${appBase}/metainfo), which acts a schema for
all parsed data. The *log* tab, will show you a log of the entry's processing. all parsed data. The *log* tab, will show you a log of the entry's processing.
` `
......
...@@ -32,7 +32,7 @@ class ConfirmDialog extends React.Component { ...@@ -32,7 +32,7 @@ class ConfirmDialog extends React.Component {
<DialogContent> <DialogContent>
<DialogContentText> <DialogContentText>
If you agree the selected uploads will move out of your private staging If you agree the selected uploads will move out of your private staging
area into the public nomad. area into the public NOMAD.
</DialogContentText> </DialogContentText>
<FormGroup row style={{alignItems: 'center'}}> <FormGroup row style={{alignItems: 'center'}}>
......
...@@ -21,9 +21,9 @@ import { CopyToClipboard } from 'react-copy-to-clipboard' ...@@ -21,9 +21,9 @@ import { CopyToClipboard } from 'react-copy-to-clipboard'
const publishedUploadsPageSize = 10 const publishedUploadsPageSize = 10
export const help = ` export const help = `
Nomad now provides a two step upload process. After you upload your files, you 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 check NOMAD's processing of your files before you publish your data. This gives you
more control about how nomad will present your data. more control about how NOMAD will present your data.
#### Prepare and upload files #### Prepare and upload files
...@@ -61,14 +61,14 @@ The *embargo* might last up to 36 month before it becomes public automatically. ...@@ -61,14 +61,14 @@ The *embargo* might last up to 36 month before it becomes public automatically.
During an *embargo* some meta-data will be available. 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 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/). [NOMAD Repository](https://repository.nomad-coe.eu/NomadRepository-1.1/).
We are working on improving this process. We are working on improving this process.
#### Co-Authors, References, Comments, Datasets #### Co-Authors, References, Comments, Datasets
Currently, this web-page is only about uploading your calculations. To further edit 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 comments, references, co-authors, share with other authors, or curate datasets, use
the [Nomad Repository](https://repository.nomad-coe.eu/NomadRepository-1.1/) on the [NOMAD Repository](https://repository.nomad-coe.eu/NomadRepository-1.1/) on
your published data (as usual). your published data (as usual).
` `
...@@ -415,7 +415,7 @@ class Uploads extends React.Component { ...@@ -415,7 +415,7 @@ class Uploads extends React.Component {
${uploadCommand.upload_tar_command} ${uploadCommand.upload_tar_command}
\`\`\` \`\`\`
As an experienced shell and *curl* user, you can modify the commands to As an experienced shell and *curl* user, you can modify the commands to
your liking. Nomad accepts stream data (\`-H <local_file>\`) or multi-form data (\`-f file=@<local_file>\`). your liking. NOMAD accepts stream data (\`-H <local_file>\`) or multi-form data (\`-f file=@<local_file>\`).
`}/> `}/>
</div> </div>
......
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