Skip to content

Commit

Permalink
add small fixes to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
budschi committed Sep 16, 2024
1 parent d1f0001 commit 91ba377
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 7 deletions.
8 changes: 4 additions & 4 deletions docs/how_to/use_this_plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ hit **CREATE**.

## Inheriting and Specializing Using Custom YAML Schemas

Here, we will guide you through how to extend and specialize the built-in schemas using custom YAML schemas. This approach allows you to tailor the schema to your specific requirements while still leveraging the standardized base provided by the plugin.
Here, we will guide you through how to extend and specialize the built-in schemas using custom YAML schemas. This approach allows you to tailor the schema to your specific requirements while still leveraging the standardized base sections provided by the plugin.

The schemas found in the plugin are general base sections and they go more and more specific in several techniques, however, they can be limiting in case of your own requirements.

Luckily, NOMAD provides a way of adding technique-specific behavior to the ELNs: YAML schemas - config file containing schemas added to the upload
Therefore, NOMAD provides a way of adding technique-specific behavior to the ELNs: YAML schemas - a config file containing schemas added to an NOMAD upload.

Using a `SolutionPreparation` example, we show how to specialize a class with a YAML schema.
Two quantities, namely `initial_temperature` and `final_temperature` are added to `AddSolutionComponent` class, and `SolutionPreparation` is customized with this new class in the `steps` subsection.
Expand All @@ -39,7 +39,7 @@ We use a custom YAML schema to define the following sections:
- `SolutionPreparation`
- `AddSolutionComponent`

This leads to an improvement over the initial class
This leads to a specialization of the initial class:

```yaml
definitions:
Expand Down Expand Up @@ -86,7 +86,7 @@ definitions:
You can learn in detail how to create your own YAML schemas in our previous [tutorial 8](https://youtu.be/5VXGZNlz9rc?feature=shared) and [tutorial 13](https://github.com/FAIRmat-NFDI/AreaA-Examples/tree/main/tutorial13/part2).
You can navigate in the [tutorial 8](https://github.com/FAIRmat-NFDI/AreaA-Examples/tree/main/tutorial8) repository
to see some other examples of YAML files that inherit and extend existing classes.
to see some other examples of YAML schemas that inherit and extend existing classes.
## Inheriting and Specializing Using Python Schema Plugins
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Currently, this plugin supports the following materials processing techniques:

Supports Solution Preparation

Additional materials processing techniques are actively being developed and will be included soon, including Synthesis from the melt (Bulk Crystal growth), Synthesis by Assembly (e.g. Polymerization).
Additional materials processing techniques are actively being developed and will be included soon, including Synthesis from the Melt (bulk crystal growth), Synthesis by Assembly (e.g. polymerization).

Stay tuned for updates as more methods become available!

Expand Down
2 changes: 0 additions & 2 deletions docs/tutorial/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ There is no specific tutorial available for the **NOMAD-material-processing plug
The FAIRmat tutorials will provide you with valuable insights into how to manage and structure materials data in NOMAD and how to contribute to community efforts like this plugin. Stay tuned for future updates, as specific tutorials for this plugin may be developed.

* [FAIRmat Tutorial 13: NOMAD for Experimental Data Management in Synthesis](https://events.fairmat-nfdi.eu/event/18/)
There is no specific tutorial on the NOMAD-material-processing plugin yet. Please look up the FAIRmat Tutorial series to learn on related topics:
13 on *NOMAD for Experimental Data Management in Synthesis* to learn on plugins and 12 general plugin, 8 for yaml

* [FAIRmat Tutorial 12: Getting started with NOMAD and NOMAD Oasis for research data management (RDM)](https://events.fairmat-nfdi.eu/event/10/)

Expand Down

0 comments on commit 91ba377

Please sign in to comment.