UPenn Logo
NiChart Logo - Image by Gerd Altmann from Pixabay

Quickstart Guide


If you already know you're interested in NiChart, this guide will help you get started as fast as possible.

There are two ways to use NiChart: from your own machine, or via NiChart Cloud. The easiest way to get started is to use NiChart Cloud, accessible from this site.


To begin, click the "NiChart Cloud" button in the header.

You will need to register an account and sign in.

If you are having trouble finding the registration email, be sure to check your spam folder.

The box on the left allows you to upload your T1 NIFTI brain scans (If you have a lot of scans, you can also upload a .zip archive.).

You can drag and drop, or use the upload button.

Wait for your files to upload. You can check the files currently on the backend server with the "View Uploaded Files" button.

When uploading large files, you may see fluctuations in the displayed progress. Do not worry -- as long as the upload does not fail, it will correct itself.


When you're ready to run image processing, click "Submit Jobs". This will spin up jobs for each scan you uploaded.

You'll see the jobs pop up shortly on the middle column. Wait for them to finish and show a green smiley.

When they're all green, you can download your ROI volumes with "Download MUSE CSV" or download the resulting images with "Download MUSE ROIs". Be patient, it takes a second to collect your output.


If you like, you can export your files directly to the next module.

This module needs both your ROI volume CSV and a separate demographics CSV file.

Press "Download Template" to see an example of the demographics CSV.

Use the file uploaders on the left to upload both files.

The rows in the demographic CSV should correspond with the same filenames from Module 1.

You can select which models to run on your data with the "Select Models" button.

When you're ready, hit "Generate SPARE Scores". One job will appear in the job list to the right.

Wait for the job to complete, then you can download your full results with "Download SPARE score CSV". This file will have not only your ROI volumes, but also your demographic information and the SPARE scores generated by the models you selected.

You can then export your data to Module 3 where you can visualize it.

This module allows you to view age trends of selected Regions of Interest in your data together with centile curves that were derived from NiChart reference samples.

Either upload your CSV from Module 2, or upload your own file. Be aware that if you upload your own file, it may not have all the fields needed to perform charting against reference datasets.

Select the ROI you want to know about and click "Add Plot". This will show you how the scans you uploaded compare to the trends for the reference data.

At any time, you can change the reference dataset to view your scans in comparison to a different reference set.

Image Processing:

You can access the image processing pipeline we utilize in the NiChart_DLMUSE package. This pipeline is built on the nnUNet framework, and detailed instructions are available in the repository's Readme. Models for all pipelines are located in the Releases section as release assets. All pipelines are accompanied with a docker container, which you can easily download and run without any installation procedure. More information can be found in the repositories' installation and usage instructions.

More pipelines are scheduled to be integrated in the NiChart Cloud, and of course made available through public repositories for local execution.


Machine Learning:

We provide the spare_score pipeline. The necessary models to operate the SPARE_scores pipeline are conveniently located in the repository's /spare_scores/mdl/ directory. Alternatively, you can find the pipeline as a docker container (models included).

Machine learning pipelines are models are constantly under development and will be integrated to the NiChart Cloud as soon as possible and we will be providing public repositories for local execution.


Visualization:

While we recommend visualizing the results of your pipeline through the NiChart Cloud, we are commited to providing alternatives for local execution and visualization. To that end, we have an open-source, PyQT-based alternative called NiChart_Viewer.


Data:

The data we've used for model training, reference centile curves, testing and validation come from the iSTAGING project.

For more information, or inquiries about the data, please contact us at nichart-devs@cbica.upenn.edu.

We will be happy to help you and answer any questions that you might have!



Please visit the Frequently Asked Questions if you have more questions!