Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
61d7e46
Migrate schema tutorial files from GitLab MR !2286 and update mkdocs …
siamakn Apr 23, 2025
115d571
Addressed review comments
siamakn Jul 28, 2025
6e4c8c9
restructure and complete ELN tutorial and custom YAML schema tutorials
siamakn Jan 30, 2026
2b5cd8b
moved P3HT_optical.csv to directory under docs/tutoria/...
siamakn Jan 30, 2026
ed7297f
corrected the path to the csv file
siamakn Jan 30, 2026
02385b5
Applying markdownlint fixes
siamakn Jan 30, 2026
a52e2d8
fixed images path to pass the test. Fixed the test itself
siamakn Feb 2, 2026
e31bc71
updated the tutorial_template
ahm531 Feb 3, 2026
bdc575b
Reverted the changes to the order of sections & Move images to an im…
ahm531 Feb 3, 2026
99e4018
Revise tutorial content for creating a custom ELN schema (intro): enh…
ahm531 Feb 3, 2026
67cabc2
Enhance tutorial on custom NOMAD ELN schema: add detailed example exp…
ahm531 Feb 3, 2026
22f9a0c
Revise tutorial on creating a custom ELN schema: enhance clarity, upd…
ahm531 Feb 11, 2026
0425664
refinements
ahm531 Feb 19, 2026
96ee8dc
reviewing the tabular_parser_yaml.md (general improvements, correctio…
ahm531 Feb 27, 2026
487ec08
Updated the tutorials admonitions legend with the checkpoint one
ahm531 Feb 27, 2026
6bf68f0
updated admonition legend
ahm531 Feb 27, 2026
8cad2de
fixed the broken paths to images on the tutorials overview page
ahm531 Feb 27, 2026
7f9cbe3
removed link to 'Create custom schemas' tutorial from navigation
ahm531 Feb 27, 2026
bfc8507
remove overview sections from custom ELN schema and the tabular parse…
ahm531 Feb 27, 2026
27d6c5c
update tutorial to remove optional designation from Step 7 on integra…
ahm531 Feb 27, 2026
cd3c7ec
remove unnecessary comments and whitespace from tutorial markdown fil…
ahm531 Feb 27, 2026
265ca00
linting
ahm531 Feb 27, 2026
b09761b
linting again
ahm531 Feb 27, 2026
b803a4f
fixed the relocated images on the explore.md
ahm531 Feb 27, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Use NOMAD as an electronic lab notebook
# Use built-in ELN templates in NOMAD

In this tutorial, we use NOMAD’s Electronic Lab Notebook (ELN) functionality to document an experiment in the NOMAD GUI. We follow the experimental workflow from defining substances and instruments to recording processing steps and measurements, using built-in ELN templates to structure and interlink the resulting entries. By the end of the tutorial, we will have documented complete experiment as a coherent, navigable ELN record in NOMAD.
In this tutorial, we use NOMAD’s Electronic Lab Notebook (ELN) functionality to document an experiment in the NOMAD GUI. We follow the experimental workflow from defining substances and instruments to recording processing steps and measurements, using built-in ELN templates to structure and interlink the resulting entries. By the end of the tutorial, we will have documented a complete experiment as a coherent, navigable ELN record in NOMAD.

![From entities and activities to structure ELN](images/ELN_0.png)

---

Expand All @@ -26,33 +28,34 @@ Before starting, make sure you have:
1. **NOMAD user account**
Creating and editing ELN entries requires a NOMAD user account.
You can create an account by following the steps described in the
[overview page](overview.md#create-a-nomad-user-account){:target="_blank" rel="noopener"}.
[overview page](../overview.md#create-a-nomad-user-account){:target="_blank" rel="noopener"}.

2. **Basic understanding of uploads and entries**
Familiarity with uploads, entries, and how they relate to each other can be helpful. These concepts are introduced in the section [key elements in NOMAD](upload_publish.md#the-key-elements-in-nomad){:target="_blank" rel="noopener"} and will be reinforced throughout the tutorial.
Familiarity with uploads, entries, and how they relate to each other can be helpful. These concepts are introduced in the section [key elements in NOMAD](../upload_publish.md#the-key-elements-in-nomad){:target="_blank" rel="noopener"} and will be reinforced throughout the tutorial.

3. **Basic familiarity with experimental workflows**
Familiarity with preparation, processing, and measurements can be helpful, but not required.

In this tutorial, we will use an example experiment involving the preparation of solution-processed polymer thin films and the measurement of their optical absorption spectrum.

??? example "About the example experiment used for this exercise"
In this exercise, we will work with an example experiment involving the preparation and characterization of Poly(3-hexylthiophene-2,5-diyl) ("P3HT") thin films. The experiment consists of three main activities: preparing solutions, depositing thin films, and measuring optical absorption.
In this exercise, we will work with an example experiment involving the preparation and characterization of poly(3-hexylthiophene-2,5-diyl) ("P3HT") thin films. The experiment consists of three main activities: preparing solutions, depositing thin films, and measuring optical absorption.

1. **Preparing solutions:** The polymer powder is mixed with a solvent in predefined quantities to achieve the desired concentration. A scale is used to accurately weigh the polymer powder, ensuring precise solution concentration.

2. **Depositing thin films:** The prepared solution is used to create a thin film on a glass substrate through spin-coating. By carefully controlling the spin speed and duration, the desired film thickness is achieved.

3. **Measuring optical absorption:** The optical absorption spectrum of the thin film is acquired using a UV-Vis-NIR spectrometer. The measurement results are saved as a .csv file for further analysis.
3. **Measuring optical absorption:** The optical absorption spectrum of the thin film is acquired using a UV-Vis-NIR spectrometer. The measurement results are saved as a `.csv` file for further analysis.

To effectively document this experiment, we will create and interlink electronic lab notebook (ELN) entries in NOMAD. These entries will include key entities such as substances, instruments, and samples, as well as activities like material processing and measurements. By structuring the data in this way, we ensure a comprehensive and FAIR-compliant record of the experiment.

![Overview of the example entities and activities](images/ELN_2.png)

---

## Create a new ELN upload

In NOMAD, an Electronic Lab Notebook (ELN) is created by initiating a NOMAD upload. This process allows you to structure and document your research data efficiently. For a step-by-step guide on how to create an upload, please refer to [this page](upload_publish.md#create-new-upload){:target="_blank" rel="noopener"}.
In NOMAD, an ELN is created by initiating a NOMAD upload. This process allows you to structure and document your research data efficiently. Create a new upload by following the steps in [Create new upload](../upload_publish.md#create-new-upload){:target="_blank" rel="noopener"}.

## Create ELN entries

Expand Down Expand Up @@ -215,7 +218,7 @@ Once the entry is created, we can fill in the relevant fields with detailed and

### Create a process entry

Now, let's create an entry using the built-in *Material Processing ELN* schema for **Preparation of P3HT solution**. Follow the steps of creating an entry described above and select *Materials Processing ELN* from the drop-down menu in step 4.
Now, let's create an entry using the built-in *Material Processing ELN* schema for **Preparation of P3HT solution**. Follow the steps of creating an entry described above and select *Material Processing ELN* from the drop-down menu in step 4.

<div style="text-align: center;">
<img src="images/ELN_built-in_22.png" alt="Material Processing ELN entry" width="400">
Expand Down Expand Up @@ -278,7 +281,7 @@ For the example process entry **Preparation of P3HT solution**, we will define t
<div class="nav-arrow right" id="next6">→</div>
</div>

Note that the added information in the **subsections** will be used to automatically fill in the Workflow graph as **tasks**, as well as **the References section**. You can find the Workflow Graph in the **OVERVIEW** tab of the entry.
Note that the added information in the **subsections** will be used to automatically fill in the *Workflow Graph* as **tasks**, as well as **the References section**. You can find the Workflow Graph in the **OVERVIEW** tab of the entry.

<div style="text-align: center;">
<img src="images/ELN_built-in_33.png" alt="Process workflow graph" width="400">
Expand All @@ -299,7 +302,7 @@ The **workflow2** section of the **Preparation of P3HT solution** example can be
</div>

??? task "Reference P3HT powder as input for the process"
For the Process ELN entry created above, make reference to the substance ELN entry *P3HT Powder* as an input of the process.
For the *Process ELN* entry created above, make reference to the *Substance ELN* entry *P3HT Powder* as an input of the process.

*Tip:* Use the workflow2 section of the entry.

Expand All @@ -316,7 +319,7 @@ We can now see the changes in the workflow graph based on our modifications in t
Now, let's create an entry using the built-in *Measurement ELN* schema for **Optical absorption measurement**. Follow the steps of creating an entry described above and select *Measurement ELN* from the drop-down menu in step 4.

<div style="text-align: center;">
<img src="images/ELN_built-in_39.png" alt="Material Processing ELN entry" width="400">
<img src="images/ELN_built-in_39.png" alt="Measurement ELN entry" width="400">
</div>

??? info "Input fields offered by the built-in schema *Measurement ELN*"
Expand Down Expand Up @@ -407,22 +410,22 @@ Imagine you have created multiple entries of substances, samples, instruments, p

1. Navigate to the **FILES** tab in your upload. This view functions like a file explorer, allowing you to view and manage files.
<div style="text-align: center;">
<img src="images/files_explorer_in_NOMAD.png" alt="interactive workflow gif" width="400">
<img src="images/files_explorer_in_NOMAD.png" alt="interactive workflow gif" width="600">
</div>

2. Add new folders and organize them according to your needs.
<div style="text-align: center;">
<img src="images/creating_new_folders.gif" alt="interactive workflow gif" width="400">
<img src="images/creating_new_folders.gif" alt="interactive workflow gif" width="600">
</div>

3. Drag and drop files into the desired folder. A prompt will appear, asking if you want to copy or move the files—choose according to your needs.
<div style="text-align: center;">
<img src="images/moving_files_to_a_folder.gif" alt="interactive workflow gif" width="400">
<img src="images/moving_files_to_a_folder.gif" alt="interactive workflow gif" width="600">
</div>

4. Once all files are sorted, take a moment to review the structure. Here’s an example of an organized ELN
<div style="text-align: center;">
<img src="images/after_organization.png" alt="interactive workflow gif" width="400">
<img src="images/after_organization.png" alt="interactive workflow gif" width="600">
</div>

**Searching your ELN entries**
Expand All @@ -448,11 +451,11 @@ On the **EXPLORE** page, you can use the filter options in the sidebar to refine

- Filter by built-in schema used to create the entry.

*For example, ELNInstrument, ELNSubstances, ELNSample, etc.*
For example: *ELNInstrument*, *ELNSubstances*, *ELNSample*, etc.

- Filter by custom tags, where you assign common tags to related entries for easy grouping.

*For example, tag all solvents as "my_solvent" or all samples as "my_samples".*
For example: tag all solvents as "my_solvent" or all samples as "my_samples".

Using these filters helps you quickly locate specific entries in your ELN.

Expand All @@ -463,7 +466,7 @@ Widgets allow you to customize your search interface to better suit your data ex
??? task "Create a custom widget for ELN sections and custom tags"
To create a custom widget for filtering your ELN, follow these steps:

1. Click on the `+ TERMS` button to open the *Edit terms widget* menu.
1. Click on the **+ TERMS** button to open the *Edit terms widget* menu.

<div style="text-align: center;">
<img src="images/widget_step_1.png" alt="Screenshot of the Edit terms widget menu" width="800">
Expand All @@ -477,9 +480,9 @@ Widgets allow you to customize your search interface to better suit your data ex
<img src="images/widget_step_2_3.png" alt="Screenshot of selecting results.eln.sections filter" width="400">
</div>

4. Write a descriptive title for the custom widget in *Title field*.
4. Write a descriptive title for the custom widget in *Title* field.

5. Click DONE!
5. Click **DONE**.

<div style="text-align: center;">
<img src="images/widget_step_4_5.png" alt="Screenshot of finalizing the custom widget" width="400">
Expand Down
Loading