ImagingDataCommons / IDC-Tutorials

Self-guided notebook tutorials to help get started with using IDC
BSD 3-Clause "New" or "Revised" License
28 stars 14 forks source link

Welcome!

This repository contains tutorial materials (for the most part, as Python notebooks) that are developed to help you learn about NCI Imaging Data Commons and utilize it in your work.

If this is the first time you hear about IDC, you may want to check out our Getting Started documentation page. Here are some highlights about what IDC has to offer:

The tutorial notebooks are located in the notebooks, and are organized in the following folders.

getting_started

"Getting Started" python notebooks are intended to introduce the users to IDC.

advanced_topics

Notebooks in this folder focus on topics that will require understanding of the basics, and aim to address more narrow use cases of IDC usage.

viewers_deployment

These notebooks can be used to deploy your own cloud-based instance of OHIF or Slim viewers using Google Firebase, which you can use to visualize analysis results you generated for IDC data, or to work with your own images. These tutorials utilize free tier of Firebase, and so there is no cost to keep the deployed viewers available in the cloud.

collectons_demos

This folders contains notebooks that demonstrate the usage of the data in the specific IDC collections. The notebooks in this folder will always have the prefix of the collection_id they correspond to, for easier navigation.

pathomics

This folder is dedicated to the notebooks focused on the digital pathology (pathomics) applications. The use of DICOM standard is relatively new in digital pathology, and this field is being actively developed, thus a dedicated folder for this.

analysis

Demonstrations/examples of analyses of images from IDC.

labs

Here you will find an archive of the notebooks that were used in tutorials, which at times may demonstrate experimental features. By design, the notebooks presented at specific events may not be updated after the event, and are stored in this folder for archival purposes.

deprecated

IDC is an actively evolving resource. As we develop new and improved capabilities, we improve our recommended usage practices, and may deprecate notebooks that are no longer maintained and may no longer work. You will find thse in the deprecated folder.

testing

This directory is used for the maintenance of the repository to support testing of the actively supported notebooks.

Support

If you have any questions about the notebooks in this repository, please open a discussion thread in IDC user forum, or open the issue in this repository.