Commit d0b34c60 authored by Markus Scheidgen's avatar Markus Scheidgen
Browse files

Added documentation about hidden search quantities to GUI.

parent 9f8c8f7a
Pipeline #69083 canceled with stages
in 13 minutes and 39 seconds
......@@ -3,6 +3,8 @@ import { withStyles, Button, IconButton, Dialog, DialogTitle, DialogContent, Dia
import Markdown from './Markdown'
import PropTypes from 'prop-types'
import HelpIcon from '@material-ui/icons/Help'
import { compose } from 'recompose'
import { withDomain } from './domains'
export const HelpContext = React.createContext()
......@@ -10,9 +12,10 @@ class HelpDialogUnstyled extends React.Component {
static propTypes = {
classes: PropTypes.object.isRequired,
title: PropTypes.string,
content: PropTypes.string.isRequired,
content: PropTypes.func.isRequired,
icon: PropTypes.node,
maxWidth: PropTypes.string
maxWidth: PropTypes.string,
domain: PropTypes.object.isRequired
static styles = theme => ({
......@@ -38,7 +41,7 @@ class HelpDialogUnstyled extends React.Component {
render() {
const {classes, title, content, icon, maxWidth,} = this.props
const {classes, title, content, icon, maxWidth, domain,} = this.props
return (
<div className={classes.root}>
<Tooltip title={title}>
......@@ -53,7 +56,7 @@ class HelpDialogUnstyled extends React.Component {
<DialogTitle>{title || 'Help'}</DialogTitle>
<Button onClick={() => this.handleClose()} color="primary">
......@@ -66,4 +69,4 @@ class HelpDialogUnstyled extends React.Component {
export default withStyles(HelpDialogUnstyled.styles)(HelpDialogUnstyled)
export default compose(withDomain, withStyles(HelpDialogUnstyled.styles))(HelpDialogUnstyled)
......@@ -3,7 +3,7 @@ import { withApi } from './api'
import Search from './search/Search'
import SearchContext from './search/SearchContext'
export const help = `
export const help = domain => `
This page allows you to **inspect** and **manage** you own data. It is similar to the
*search page*, but it will only show data that was uploaded by you or is shared with you.
......@@ -10,7 +10,7 @@ import qs from 'qs'
import KeepState from '../KeepState'
import { guiBase } from '../../config'
export const help=`
export const help = domain => `
The *raw files* tab, will show you all files that belong to the entry and offers a download
on individual, or all files. The files can be selected and downloaded. You can also
view the contents of some files directly here on this page.
......@@ -9,7 +9,7 @@ import { FormControl, withStyles, Select, Input, MenuItem, ListItemText, InputLa
import { compose } from 'recompose'
import { schema } from '../MetaInfoRepository'
export const help = `
export const help = domain => `
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
all its definitions here.
......@@ -7,8 +7,9 @@ import { withApi } from '../api'
import Search from './Search'
import SearchContext from './SearchContext'
import qs from 'qs'
import { withDomain } from '../domains'
export const help = `
export const help = domain => `
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 part
shows all data that fulfills your search criteria.
......@@ -29,6 +30,11 @@ The visual representations show metrics for all data that fit your criteria.
You can display *entries* (i.e. code runs), *unique entries*, and *datasets*.
Other more specific metrics might be available.
Some quantities have no autocompletion for their values. You can still search for them,
if you know exactly what you are looking for. To search for a particular entry by its id
for example, type \`calc_id=<the_id>\` and press entry (or select the respective item from the menu).
The usable *hidden* quantities are: ${Object.keys(domain.additionalSearchKeys).map(key => `\`${key}\``).join(', ')}.
The results tabs gives you a quick overview of all entries and datasets that fit your search.
You can click entries to see more details, download data, see the archive, etc. The *entries*
tab displays individual entries (i.e. code runs), the *grouped entries* tab will group
......@@ -53,7 +59,8 @@ class SearchPage extends React.Component {
user: PropTypes.object,
location: PropTypes.object,
raiseError: PropTypes.func.isRequired,
update: PropTypes.number
update: PropTypes.number,
domain: PropTypes.object
static styles = theme => ({
......@@ -93,4 +100,4 @@ class SearchPage extends React.Component {
export default compose(withApi(false), withErrors, withStyles(SearchPage.styles))(SearchPage)
export default compose(withDomain, withApi(false), withErrors, withStyles(SearchPage.styles))(SearchPage)
......@@ -17,7 +17,7 @@ import { CopyToClipboard } from 'react-copy-to-clipboard'
import { guiBase } from '../../config'
import qs from 'qs'
export const help = `
export const help = domain => `
NOMAD allows you to upload data. After upload, NOMAD will process your data: it will
identify the main output files of [supported codes](
and then it will parse these files. The result will be a list of entries (one per each identified mainfile).
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