Deployed 31324ff with MkDocs version: 1.2.3

how_to/use_this_plugin.html

@@ -68,6 +68,11 @@
     <label class="md-overlay" for="__drawer"></label>
     <div data-md-component="skip">
 
+
+        <a href="#how-to-use-this-plugin" class="md-skip">
+          Skip to content
+        </a>
+
     </div>
     <div data-md-component="announce">
 
@@ -245,11 +250,44 @@
       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
 
 
+
+
+
+        <label class="md-nav__link md-nav__link--active" for="__toc">
+          Use this Plugin
+          <span class="md-nav__icon md-icon"></span>
+        </label>
 
       <a href="use_this_plugin.html" class="md-nav__link md-nav__link--active">
         Use this Plugin
       </a>
 
+
+
+<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+
+
+
+
+
+
+    <label class="md-nav__title" for="__toc">
+      <span class="md-nav__icon md-icon"></span>
+      Table of contents
+    </label>
+    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
+
+        <li class="md-nav__item">
+  <a href="#add-this-plugin-to-your-nomad-instalation" class="md-nav__link">
+    Add This Plugin to Your NOMAD instalation
+  </a>
+
+</li>
+
+    </ul>
+
+</nav>
+
     </li>
 
 
@@ -298,15 +336,62 @@
               </div>
 
 
+
+              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
+                <div class="md-sidebar__scrollwrap">
+                  <div class="md-sidebar__inner">
+
+
+<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+
+
+
+
+
+
+    <label class="md-nav__title" for="__toc">
+      <span class="md-nav__icon md-icon"></span>
+      Table of contents
+    </label>
+    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
+
+        <li class="md-nav__item">
+  <a href="#add-this-plugin-to-your-nomad-instalation" class="md-nav__link">
+    Add This Plugin to Your NOMAD instalation
+  </a>
+
+</li>
+
+    </ul>
+
+</nav>
+                  </div>
+                </div>
+              </div>
+
 
           <div class="md-content" data-md-component="content">
             <article class="md-content__inner md-typeset">
 
 
 
-  <h1>Use this Plugin</h1>
-
-
+<h1 id="how-to-use-this-plugin">How to Use This Plugin<a class="headerlink" href="#how-to-use-this-plugin" title="Permanent link">&para;</a></h1>
+<p>This plugin can be used in a NOMAD Oasis instalation..</p>
+<h2 id="add-this-plugin-to-your-nomad-instalation">Add This Plugin to Your NOMAD instalation<a class="headerlink" href="#add-this-plugin-to-your-nomad-instalation" title="Permanent link">&para;</a></h2>
+<p>Read the <a href="https://nomad-lab.eu/prod/v1/staging/docs/plugins/plugins.html#add-a-plugin-to-your-nomad">NOMAD plugin documentation</a> for all details on how to deploy the plugin on your NOMAD instance.</p>
+<p>You need to modify the <code>nomad.yaml</code> configuration file of your NOMAD instance. Add the following lines: .</p>
+<p><code>yaml
+keycloak:
+  realm_name: fairdi_nomad_test
+plugins:
+  # We only include our schema here. Without the explicit include, all plugins will be
+  # loaded. Many build in plugins require more dependencies. Install nomad-lab[parsing]
+  # to make all default plugins work.
+  include:
+  - 'schemas/nomad_measurements/xrd'
+  options:
+    schemas/nomad_measurements/xrd:
+      python_package: nomad_measurements.xrd</code></p>
 
 
             </article>

search/search_index.json

@@ -1 +1 @@
-{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"index.html","text":"Welcome to the nomad-measurements plugin documentation \u00b6 This plugin provides NOMAD schemas, readers and parsers for materials science measurements. Introduction \u00b6 This is a NOMAD plugin. For information on how to use them, see NOMAD Plugins . Supported measurement techniques \u00b6 At the moment, the following measurement techniques are supported: X-ray diffraction \u00b6 Supported file formats: PANalytical .xrdml Rigaku .rsx","title":"Home"},{"location":"index.html#welcome-to-the-nomad-measurements-plugin-documentation","text":"This plugin provides NOMAD schemas, readers and parsers for materials science measurements.","title":"Welcome to the nomad-measurements plugin documentation"},{"location":"index.html#introduction","text":"This is a NOMAD plugin. For information on how to use them, see NOMAD Plugins .","title":"Introduction"},{"location":"index.html#supported-measurement-techniques","text":"At the moment, the following measurement techniques are supported:","title":"Supported measurement techniques"},{"location":"index.html#x-ray-diffraction","text":"Supported file formats: PANalytical .xrdml Rigaku .rsx","title":"X-ray diffraction"},{"location":"explanation/explanation.html","text":"","title":"Explanation"},{"location":"how_to/use_this_plugin.html","text":"","title":"Use this Plugin"},{"location":"reference/references.html","text":"","title":"References"},{"location":"tutorial/tutorial.html","text":"","title":"Tutorials"}]}
+{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"index.html","text":"Welcome to the nomad-measurements plugin documentation \u00b6 This plugin provides NOMAD schemas, readers and parsers for materials science measurements. Introduction \u00b6 This is a NOMAD plugin. For information on how to use them, see NOMAD Plugins . Supported measurement techniques \u00b6 At the moment, the following measurement techniques are supported: X-ray diffraction \u00b6 Supported file formats: PANalytical .xrdml Rigaku .rsx","title":"Home"},{"location":"index.html#welcome-to-the-nomad-measurements-plugin-documentation","text":"This plugin provides NOMAD schemas, readers and parsers for materials science measurements.","title":"Welcome to the nomad-measurements plugin documentation"},{"location":"index.html#introduction","text":"This is a NOMAD plugin. For information on how to use them, see NOMAD Plugins .","title":"Introduction"},{"location":"index.html#supported-measurement-techniques","text":"At the moment, the following measurement techniques are supported:","title":"Supported measurement techniques"},{"location":"index.html#x-ray-diffraction","text":"Supported file formats: PANalytical .xrdml Rigaku .rsx","title":"X-ray diffraction"},{"location":"explanation/explanation.html","text":"","title":"Explanation"},{"location":"how_to/use_this_plugin.html","text":"How to Use This Plugin \u00b6 This plugin can be used in a NOMAD Oasis instalation.. Add This Plugin to Your NOMAD instalation \u00b6 Read the NOMAD plugin documentation for all details on how to deploy the plugin on your NOMAD instance. You need to modify the nomad.yaml configuration file of your NOMAD instance. Add the following lines: . yaml keycloak: realm_name: fairdi_nomad_test plugins: # We only include our schema here. Without the explicit include, all plugins will be # loaded. Many build in plugins require more dependencies. Install nomad-lab[parsing] # to make all default plugins work. include: - 'schemas/nomad_measurements/xrd' options: schemas/nomad_measurements/xrd: python_package: nomad_measurements.xrd","title":"Use this Plugin"},{"location":"how_to/use_this_plugin.html#how-to-use-this-plugin","text":"This plugin can be used in a NOMAD Oasis instalation..","title":"How to Use This Plugin"},{"location":"how_to/use_this_plugin.html#add-this-plugin-to-your-nomad-instalation","text":"Read the NOMAD plugin documentation for all details on how to deploy the plugin on your NOMAD instance. You need to modify the nomad.yaml configuration file of your NOMAD instance. Add the following lines: . yaml keycloak: realm_name: fairdi_nomad_test plugins: # We only include our schema here. Without the explicit include, all plugins will be # loaded. Many build in plugins require more dependencies. Install nomad-lab[parsing] # to make all default plugins work. include: - 'schemas/nomad_measurements/xrd' options: schemas/nomad_measurements/xrd: python_package: nomad_measurements.xrd","title":"Add This Plugin to Your NOMAD instalation"},{"location":"reference/references.html","text":"","title":"References"},{"location":"tutorial/tutorial.html","text":"","title":"Tutorials"}]}