Skip to content
This repository was archived by the owner on Jul 15, 2026. It is now read-only.

Commit 8b3277f

Browse files
authored
tutorial: add synthesis experiment (#10)
* tutorial: add synthesis experiment * fix typo
1 parent 5afdf2b commit 8b3277f

10 files changed

Lines changed: 91 additions & 0 deletions
Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
---
2+
sidebar_position: 7
3+
title: Creating a synthesis experiment (chemistry)
4+
---
5+
6+
This tutorial will show you how to use eLabFTW for registering chemistry experiments.
7+
8+
:::note
9+
There might be several ways to approach this. We're just showing you one way to do it.
10+
:::
11+
12+
## Creating a template
13+
14+
It is a good idea to start by creating an Experiment Template for Synthesis experiments. Before that, let's create an Experiment Category: "Synthesis".
15+
16+
### Add a category
17+
18+
Go to "Experiments categories" page from the menu:
19+
20+
<figure>
21+
<img src="/img/tuto-syn-exp-cat-menu.webp" alt="Experiment categories menu" />
22+
<figcaption>Experiment categories menu</figcaption>
23+
</figure>
24+
25+
Click the "Create" button and add a category: "Synthesis".
26+
27+
<figure>
28+
<img src="/img/tuto-syn-create-category.webp" alt="Create experiment category" />
29+
<figcaption>Create experiment category</figcaption>
30+
</figure>
31+
32+
### Add a template
33+
34+
Next, go to "Experiments templates" page and create a new Experiment Template.
35+
36+
<figure>
37+
<img src="/img/tuto-syn-exp-tpl-menu.webp" alt="Experiment template menu" />
38+
<figcaption>Experiment template menu</figcaption>
39+
</figure>
40+
41+
42+
Name it "Basic synthesis" or something similar.
43+
44+
<figure>
45+
<img src="/img/tuto-syn-create-tpl.webp" alt="Create experiment template" />
46+
<figcaption>Create experiment template</figcaption>
47+
</figure>
48+
49+
Set the Category to "Synthesis" by clicking the first "Not set" above the title.
50+
51+
<figure>
52+
<img src="/img/tuto-syn-change-category.webp" alt="Set category" />
53+
<figcaption>Set category</figcaption>
54+
</figure>
55+
56+
Now use the Main Text and the Custom fields to describe what you expect to have in your experiment. You can have a table, you can have links to compounds, ask the user to log various parameters such as pH or temperature.
57+
58+
<figure>
59+
<img src="/img/tuto-syn-custom-fields.webp" alt="Custom fields" />
60+
<figcaption>Custom fields</figcaption>
61+
</figure>
62+
63+
## Creating the experiment
64+
65+
Once you're satisfied with your template, create an experiment from that template. Click the "Create" button from the Experiments page, add a title and select the template:
66+
67+
<figure>
68+
<img src="/img/tuto-syn-create-from-template.webp" alt="Create experiment from template" />
69+
<figcaption>Create experiment from template</figcaption>
70+
</figure>
71+
72+
Then fill the Custom fields and Main Text with information about the experiment.
73+
74+
75+
## Using the Structure Editor
76+
77+
From the Tools menu, select the "Chemical Structure Editor".
78+
79+
This editor allows you to draw a reaction. You can then save the reaction as RXN file and attach that file to your experiment (we're working on making this step easier without having to download the file).
80+
81+
<figure>
82+
<img src="/img/tuto-syn-editor.webp" alt="Chemical structure editor" />
83+
<figcaption>Chemical structure editor</figcaption>
84+
</figure>
85+
86+
You can also export it in PNG so you can have the image in the Main text and display it from the main page by toggling the main content:
87+
88+
<figure>
89+
<img src="/img/tuto-syn-show.webp" alt="Listing reactions" />
90+
<figcaption>Listing reactions</figcaption>
91+
</figure>
8.56 KB
Loading
10.2 KB
Loading
31.3 KB
Loading
19.4 KB
Loading
16.1 KB
Loading

static/img/tuto-syn-editor.webp

49.8 KB
Loading
16.7 KB
Loading
18.1 KB
Loading

static/img/tuto-syn-show.webp

44 KB
Loading

0 commit comments

Comments
 (0)