Skip to content

Commit 73e803d

Browse files
TasnimMehzabinTasnim Mehzabin
andauthored
update: docs: local collector (#503)
- for consistency and clarity Co-authored-by: Tasnim Mehzabin <tasnim.mehzabin@live.com>
1 parent 56ea8ae commit 73e803d

5 files changed

Lines changed: 17 additions & 9 deletions

File tree

docs/eln/devices/configurations/local_collector.mdx

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ title: Local Collectors (in docker containers)
33
sidebar_label: Local Collectors (in docker containers)
44
---
55

6-
The ELN allows data to be collected automatically from a folder using the data-collector feature. This is useful for sharing files between e.g. an instrument and the ELN. On the instrument side, the (analyses, result etc.) files can be put in a (networked shared) older. On the ELN side, we can monitor this folder for any changes and import files from the instrument directly into the ELN.
6+
The ELN allows data to be collected automatically from a folder using the data-collector feature. This is useful for
7+
sharing files between e.g. a device and the ELN. On the device side, the (analyses, result etc.) files can be put in a (networked shared) older. On the ELN side, we can monitor this folder for any changes and import files from the device directly into the ELN.
78

89
## Configuration outside Chemotion ELN
910

@@ -19,14 +20,14 @@ Once the computer that is running the Chemotion ELN (docker container) has acces
1920
...
2021
volumes:
2122
- ...
22-
- /path/to/folder/with/data:/chemotion/datacollector/instrument-name
23+
- /path/to/folder/with/data:/chemotion/datacollector/device-name
2324
2425
worker:
2526
image: ...
2627
...
2728
volumes:
2829
- ...
29-
- /path/to/folder/with/data:/chemotion/datacollector/instrument-name
30+
- /path/to/folder/with/data:/chemotion/datacollector/device-name
3031
3132
```
3233

@@ -35,7 +36,7 @@ Once the computer that is running the Chemotion ELN (docker container) has acces
3536
config/datacollector.yml file if it does not exist.
3637

3738
Note that, you can input multiple paths i.e. mount different instruments. For example, the second commented line here mounts the folder `/tmp/datacollector` which can point to some
38-
other instrument.
39+
other device.
3940

4041
```
4142
:localcollectors:
@@ -49,10 +50,10 @@ Once the computer that is running the Chemotion ELN (docker container) has acces
4950

5051
## Configurations in Chemotion ELN: Admin Panel
5152

52-
We have to navigate to _Groups & Devices_ in the admin panel and create a new device instance. It will register the device
53+
We have to navigate to _Devices_ in the admin panel and create a new device instance. It will register the device
5354
information to the database of the Chemotion ELN.
5455

55-
![collector_configuration_1](/img/collector_configuration1.png)
56+
![collector_configuration_1](/img/data_collector/collector_configuration1.png)
5657

5758
### File Collector
5859

@@ -66,7 +67,7 @@ specify the following,
6667
In this case we will configure the watch method as `filewatcherlocal` as we intend to collect files from the
6768
specified Watch Directory.
6869

69-
![collector_configuration_1](/img/collector_configuration2.png)
70+
![collector_configuration_1](/img/data_collector/collector_configuration2.png)
7071

7172
As the next step, files from the `./datacollector/CV-data` will now keep being collected by the collector in the
7273
Chemotion ELN. We have to make sure that the name of the files start with the name abbreviation (Kürzel) of a specific
@@ -87,12 +88,19 @@ directories will be removed.
8788

8889
:::
8990

91+
:::info
92+
93+
To know more about the user-level data collection, please check
94+
[here](https://chemotion.net/docs/eln/devices/configurations/user_level_collection)
95+
96+
:::
97+
9098
### Folder Collector
9199

92100
All the configurations are more or less the same as in the File Collector. Here we will need to configure the Watch
93101
Method as `folderwatcherlocal`.
94102

95-
![collector_configuration_1](/img/collector_configuration3.png)
103+
![collector_configuration_1](/img/data_collector/collector_configuration3.png)
96104

97105
Here is a new input to consider, i.e. `Number of files`. As mentioned in the info text in the Chemotion ELN, if the
98106
folders to be collected may contain a variable number of files, then we have to set it to 0. Otherwise if the number of

docs/eln/devices/configurations/user_level_collection.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Folders along with their contents marked in red zone will be delete
3737

3838
![folder_collection_1](/img/data_collector/data_collector_folder_1.png)
3939

40-
:::caution Warning
40+
:::caution[Warning]
4141

4242
Whether it is a file or folder, they will be deleted from the device folder after each collection operation
4343

81.4 KB
Loading
114 KB
Loading
113 KB
Loading

0 commit comments

Comments
 (0)