playbooks

BioImage Archive Upload

This is a short, practical guide to uploading datasets to the BioImage Archive.

What is BioImage Archive?

BioImage Archive is a public repository for biological imaging data. It hosts raw image datasets with stable accession IDs so others can find, access, and reuse the data tied to a publication or project.

When to use this

Use this guide when a project is ready to publish raw image data and the authoring team has decided to deposit in the BioImage Archive.

If you run into questions or issues

⚠️ If you run into trouble or questions, reach out to bioimage-archive@ebi.ac.uk to help address issues.

Prerequisites

Quick steps

  1. Organize files into a single local submission folder. If the files are stored on a network share, consider copying them locally to ensure the transfer to BioImage Archive is seamless.

  2. Login or create account on the BioImage Archive login page (accounts are free to create).

  3. Upload files using “files” tab (bulk uploads require Aspera or FTP). The bulk connection information unique to your account is available under the “FTP/Aspera” button. Note: you can use rclone here to help manage the FTP connection transfers from the command line.

  4. Fill out a new submission from the “submissions” tab. Note: you can copy and paste fields into a Google Doc (or another service) for verification with your authoring team.

  5. Generate “study component” for uploaded files with (one for each type of file).

You’ll need to generate a .tsv file like this for the field:

Files   File Type   File Size
filename.tif    image/tiff  7225258
...
  1. Submit for review and record the accession ID.

After submission

  1. Watch the “submissions” tab for challenges with your upload (it will show an icon indicating there’s an issue which needs to be resolved if something comes up).

  2. Once the submission is successful you’ll have access to a link which looks like this from the “submissions” tab.