How to guide: Getting started with the beta release

How to guide: Getting started with the beta release

Welcome to CODI! This article explains how to make an account and upload a dataset.

CODI home page

The CODI home page shows a gallery of datasets. At any point, it is possible to return to this page by clicking on the CODI logo in the top left of the page.

Creating an account

To create a new account, start by clicking on the user icon in the top right corner.

A popup window will appear which handles the log in.

Here either use a google account to log in or click on 'Create an ONI account'.


On the next page simply continue.

Now enter user details,

and choose a password.

Check the relevant email inbox for a confirmation from ONI for this newly created account.

When it arrives, click on the link to confirm the email address.

A new popup should display.

At this point click on the ‘I’ve confirmed my email address’ button in the previous popup window. This account is now activated and available for logging in.

Logging in

Click on the user icon in the top right corner and enter login details.

If all goes well the popup should disappear and the user icon should now be colored and show the user initials.

A new upload button should appear alongside the user icon, this will come in handy for the next steps.

Uploading a dataset

Logged in users can upload datasets, click on the upload icon in the top right corner.

This will open the upload page.

To upload a dataset named ‘example’ the files would be:

  • example.locb

  • example_map.nim

  • example_acq.nim

  • optionally any other files with the same prefix e.g. example.txt

(users can ignore the .pointCloud option, this is currently an internal file type)

To add these files, either drag and drop or click on the folder icon to navigate and select files from the local file system. Once added the upload page should look like this:

At this point a few options are available (note that any options on the left hand side can be adjusted after uploading too):

  • Adjust the dataset title for CODI

  • Add a description

  • Add tags to the dataset

  • Choose to make the dataset public on upload (datasets default to private)

  • View a list of files ready to upload

  • Remove all files from the upload list

  • Add more files to be uploaded to this dataset

Once these options are set, click the ‘Upload all’ button to upload and create a dataset.

Upload progress is displayed in percentages for each file.

Once uploaded the dataset will need to be optimised for the cloud, this process can take a minute or two. After this, the dataset will be ready to view and analyse by clicking on the purple arrow button.

Note that if the purple arrow is clicked before optimisation is complete, then the dataset information page may show a warning complaining about a missing .pointCloud file. This is a known issue and the warning can be safely ignored as an optimisation is already running.

Opening a dataset

When clicking through to a newly uploaded dataset, or opening a dataset from the home page, CODI will navigate to the dataset’s information page. On this page there is a summary of the dataset including:

  • A dataset menu bar along the left edge

  • Saved views of the dataset

  • Dataset details including title, tags and description (editable for dataset owners)

  • Comments

  • Executions run on the dataset

  • The rating star for the dataset

  • Acquisition metadata

  • Channel names (editable for dataset owners)

Dataset owners can also see files in the dataset further down the information page

The additional files shown here are generated during the cloud optimisation process.

Visualising a dataset

To visualise a dataset click on a dataset view to be taken to that snapshot in the viewer, or click on the STORM icon in the left side menu.

If clicking on the STORM icon CODI will open the online viewer with the localisation filtering tool opened by default.

This is the CODI viewer! Users can explore datasets using navigation similar to viewing maps online, for example:

  • pinch/scroll to zoom in and out

  • click and drag to pan

  • right click and drag to rotate

    • Related Articles

    • How to guide: CODI Apps and Batch Analysis

      Tool view Purpose of the tool CODI Apps operate within a new analysis ecosystem, an enhanced version of the platform. Each App contains a set of powerful analysis tools that enable scientists to create, save and run end-to-end batch analysis ...
    • How to guide: Clustering tool

      Tool view Purpose of tool The tool performs clustering on localisation data to find biological structures and quantify their statistical and morphological properties. The default clustering method is HDBSCAN. The cluster results can then be ...
    • How-to-guide: How to share and organize your data

      Tool View Purpose of tool CODI is a Collaborative Discovery platform to share your data and analyses with colleagues and the public, opening up new possibilities for cross dataset insights. Using our tool Collaborations you will be able to organize, ...
    • How to guide: Visualization panel

      Tool view Note: the visualisation panel is visible in all current CODI widgets on the left hand side of the screen.   Purpose of tool Enables the user to customise the main view of the dSTORM acquisition. Contents 2D options 3D options Channel ...
    • How to guide: Drift correction

      Tool view   Purpose of tool This tool attempts to correct for the drift that occurs during an acquisition. Without this correction the resolution of the sample is degraded which will affect visual quality as well as downstream analysis. The drift ...