diff --git a/docs/how_to/ScreenshotCreateBuiltInSchema.png b/docs/how_to/ScreenshotCreateBuiltInSchema.png index e85a260..c06adc0 100755 Binary files a/docs/how_to/ScreenshotCreateBuiltInSchema.png and b/docs/how_to/ScreenshotCreateBuiltInSchema.png differ diff --git a/docs/how_to/ScreenshotReactionMeasurementEntry.png b/docs/how_to/ScreenshotReactionMeasurementEntry.png new file mode 100755 index 0000000..cf59ab3 Binary files /dev/null and b/docs/how_to/ScreenshotReactionMeasurementEntry.png differ diff --git a/docs/how_to/ScreenshotSampleEntry.png b/docs/how_to/ScreenshotSampleEntry.png new file mode 100755 index 0000000..ab4723e Binary files /dev/null and b/docs/how_to/ScreenshotSampleEntry.png differ diff --git a/docs/how_to/use_this_plugin.md b/docs/how_to/use_this_plugin.md index e2eaaa8..8fd3cd8 100644 --- a/docs/how_to/use_this_plugin.md +++ b/docs/how_to/use_this_plugin.md @@ -13,10 +13,12 @@ When creating single entries, it may be easiest to manually fill the schemas in ![image with screenshot of the NOMAD GUI](ScreenshotCreateBuiltInSchema.png) ## The **Catalyst Sample** schema -TODO +Below you see a fresh instance of a **Catalyst Sample** entry, which can be filled directly in the GUI. +![image of sample instance in the NOMAD GUI](ScreenshotSampleEntry.png) ## The **Catalytic Reaction** schema - +Here you see a screenshot of an empty **Catalytic Reaction** measurement entry. +![image of measurement instance for a catalytic reaction](ScreenshotReactionMeasurement.png) ### Populate the CatalyticReaction schema from a data file @@ -36,6 +38,7 @@ For excel files with multiple sheets, only the first sheet is read. If a column it will be ignored. The following column headers will be recognized and mapped into the NOMAD schema: + |excel column header | description | schema quantity| |---|---|---| | `catalyst` | name of the catalyst| reactor_filling.catalyst_name diff --git a/docs/index.md b/docs/index.md index 940cbb3..041358b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -20,19 +20,10 @@ This plugin aims at facilitating the catalysis researchers life by providing a f tool to manage, vizualize, analyze and share catalyst and reactivity data. Currently it is still in development and feedback about the plugin and documentation is welcome. -
-
- ## Included Entry Types This plugin includes two new NOMAD entry types: `CatalystSample` and `CatalyticReaction`. More information can be found in the [References](reference/references.md) and the [How-to guides](How_to/use_this_plugin.md). -### Tutorial - -TODO - -- [Tutorial](tutorial/tutorial.md) - -
+
### How-to guides @@ -41,8 +32,6 @@ How-to guides provide step-by-step instructions for a wide range of tasks, with - [Install this plugin](how_to/install_this_plugin.md) - [Use this plugin](how_to/use_this_plugin.md) -- [Contribute to this plugin](how_to/contribute_to_this_plugin.md) -- [Contribute to the documentation](how_to/contribute_to_the_documentation.md)
@@ -55,4 +44,5 @@ The reference [section](reference/references.md) includes all sections and their as well as the necessary format for the possible datafiles of the catalytic reaction.
+