Commit 836f1727 authored by Markus Scheidgen's avatar Markus Scheidgen
Browse files

Added some figs to docs. Improved integrated docs css.

parent 6436f3c8
No preview for this file type
Welcome to NOMAD's documentation!
=================================
nomad xt
========
This project tries and test approaches that might lead to an improved architecture for NOMAD (XT).
This project is a prototype for the continuation of the original NOMAD-coe software
and infrastructure with a simplyfied and improved architecture.
.. toctree::
:maxdepth: 2
setup
contributing
introduction
modules
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
contributing
Introduction
============
Nomad xt (and NOMAD coe) is about software for storing and processing (computational)
material science data based on *big-data* and *disributed computing*.
Architecture
------------
The following depicts the *nomad-xt* architecture with respect to software compenent
in terms of python modules, gui components, and 3rd party services (e.g. databases,
search enginines, etc.)
.. figure:: components.png
:alt: nomad xt components
The main components of nomad xt and their dependencies.
Principles
----------
* simple first, complicated only when necessary
* adopting generic established 3rd party solutions before implementing specific solutions
* only uni directional dependencies between components/modules, no circles
* only one language: Python (except, GUI of course)
\ No newline at end of file
......@@ -22,6 +22,7 @@
<!-- fonts needed by material-ui -->
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,500">
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto+Mono:400,500">
<title>nomad xt</title>
</head>
<body>
......
......@@ -6,6 +6,10 @@
width: 1000px;
}
.root code {
font-family: "Roboto Mono", monospace;
}
.root .documentwrapper {
float: left;
width: 700px;
......@@ -38,7 +42,7 @@
.root h1 {
color: rgba(0, 0, 0, 0.54);
margin: 32px 0 16px;
margin: 32px 0 24px;
font-size: 2.8125rem;
font-weight: 400;
font-family: "Roboto", "Helvetica", "Arial", sans-serif;
......@@ -56,7 +60,7 @@
.root h3 {
color: rgba(0, 0, 0, 0.87);
margin: 0 0 40px;
margin: 24px 0 18px;
font-size: 1.5rem;
font-weight: 400;
font-family: "Roboto", "Helvetica", "Arial", sans-serif;
......@@ -65,6 +69,7 @@
.root h4 {
color: rgba(0, 0, 0, 0.87);
margin: 18px 0 12px;
font-size: 1rem;
font-weight: 400;
font-family: "Roboto", "Helvetica", "Arial", sans-serif;
......@@ -99,3 +104,53 @@
text-decoration: none;
}
.root img {
width: 700px;
}
.root .caption {
text-align: center;
color: rgba(0, 0, 0, 0.54);
font-size: 14px;
font-weight: 400;
font-family: "Roboto", "Helvetica", "Arial", sans-serif;
line-height: 1.375;
}
.root div.admonition {
margin-top: 10px;
margin-bottom: 10px;
padding: 7px;
}
.root div.admonition dt {
font-weight: bold;
}
.root div.admonition dl {
margin-bottom: 0;
}
.root p.admonition-title {
margin: 0px 10px 5px 0px;
font-weight: bold;
}
.root div.body p.centered {
text-align: center;
margin-top: 25px;
}
.root dd p {
margin-top: 0;
}
.root .field-body strong {
font-family: "Roboto Mono", monospace;
}
.root .descname {
font-weight: 500;
}
......@@ -31,6 +31,14 @@ const processingInstructions = location => {
return (<Link smooth to={pathname + (linkUrl.hash || '#')}>{children}</Link>)
}
},
{
// We have to redirect img src attributes to the static sphynx build dir.
shouldProcessNode: node => node.type === 'tag' && node.name === 'img' && node.attribs['src'] && !node.attribs['src'].startsWith('http'),
processNode: (node, children) => {
node.attribs['src'] = `/docs/${node.attribs['src']}`
return processNodeDefinitions.processDefaultNode(node)
}
},
{
shouldProcessNode: node => true,
processNode: processNodeDefinitions.processDefaultNode
......
......@@ -29,6 +29,12 @@ in :py:mod:`nomad.files`, :py:mod:`nomad.search`, :py:mod:`nomad.users`,
Represent processing state
--------------------------
.. figure:: process.png
:alt: nomad xt processing workflow
This is the basic workflow of a nomad xt upload processing.
.. autoclass:: ProcPipeline
.. autoclass:: UploadProc
.. autoclass:: CalcProc
......
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