Upload large data sets¶
Introduction¶
OpenBIS is designed to store both the data and the metadata from your research project. The metadata usually describes how you performed your study, while the data contains the measurements and observations in your experiments. These are often very large files, that the data upload via ELN UI cannot handle reliably, which is the case for files larger than 10 GB.
To upload larger datasets (> 10GB), we offer another way through Empa's N:
drive where you can simply drag and drop your files in a lab related folder and after a delay of approx. 20 minutes the upload appears as an attachment on your chosen openBIS entity (e.g. collection, object etc.).
To learn how to upload large data to openBIS, which is called data upload via (ELN-LIMS) dropbox
by ETH, please follow the instructions below.
Instructions¶
-
First, you need to decide which upload strategy you want to adopt:
- auto: openBIS continuously monitors the upload directory named auto and when a new file appears it is automatically moved to openBIS as an attachment after a predefined inactivity period (usually 20 minutes). This waiting time is added to prevent the system to start an upload while a large file is still being copied to the upload directory.
- marker: the upload to openBIS is started when the system sees a special file called marker file. This is ideal to upload very large files which can take long time to move to the upload directory.
-
Then, you need to find the upload folder for your openBIS group. On your Empa machine, go to
N:
drive and see folders named after the following structure:OB-LXXX-Groupname
XXX
is the ID of your instance, which corresponds to the number of your department.-
Groupname
is the name of the openBIS group you belong to. It can be a name chosen by your lab members when setting up openBIS or the default nameAbtXXX
whereXXX
is the official lab number. For example, for the department 502, we haveOB-502AIM
for theAIM
group of lab 502, as shown in the screenshot.
-
Open the ELN UI browser of your lab, choose the right login, and navigate to the entity (object or experiment/collection) where you want to upload data. In this example, we want to upload a file to the collection
Creep measurements
of Maurice Biot's lab notebook. -
Follow the instructions in this link to create the folder connected to the upload place in openBIS (e.g. collection
Creep measurements
) and if needed the marker file with the correct naming (in case of the marker upload option). When following the instructions, be aware that ETH documentation calls the folder in N:drive (e.g.OB-502AIM
orOB-L207-Abt207
) the eln-lims-dropbox folder. Depending on the upload version you will use onN:
drive in the folderOB-LXXX-Groupname
(e.g.OB-502AIM
orOB-L207-Abt207
) the already existing foldersauto
ormarker
: -
When you created all folders in the right place according to the instructions above, you can move your data files or data directory inside.
-
Data files will be automatically uploaded to openBIS after the following timeframe depending on the upload option auto or marker:
- auto: 20 minutes after nothing happend anymore in the folder auto
- marker: Shortly after the marker file appeared in the right folder
-
Check via Dropbox monitor the status of the data upload.
It is also possible to register metadata for datasets via this so called dropbox upload
, which was described above. Check the instructions here.