Skip to content

FNNDSC/CHRIS_docs

Repository files navigation

ChRIS

Abstract

This page presents a quick overview of ChRIS, followed by some links to more resources, papers, and talks.

PACS Pull Output

Overview

ChRIS (ChRIS Research Integration Service) is an opensource distributed software platform designed to manage and coordinate computation and data on a multitude of computing environments. Originally developed for medical image analysis in the Fetal-Neonatal Neuroimaging and Developmental Science Center at Boston Children's Hospital, ChRIS has evolved into a general-purpose compute/data platform making it easy to deploy analysis on a heterogenous mix of compute environments -- from laptops to loosely connected groups of workstations, to high performance compute clusters, to public clouds.

ChRIS is designed to manage the execution and data needs of a specific class of computational applications often used in research (and in particular medical image research) settings. These are applications that require no user interaction once started, have runtime specifications typically passed in command line arguments, and collect all output in files.

While ChRIS itself has a web-based user interface, the applications that perform the computations are containerized, Linux-based applications. Since these apps run "in the woodwork" so to speak, they are called plugins in ChRIS parlance, since they plug-into the ChRIS backend and are accessible from a suitable frontend.

ChRIS comprises a collection of REST-based web services, backend web apps, and various client-facing web front ends. The system is designed to make it as easy as possible for a developer to get his/her app running anywhere (by which is meant any computing environment that can run linux containers). By conforming to a reasonable command-line specification or contract for ChRIS applications, ChRIS makes it easy to containerize and run the research software, collect results, visualize data, and share/collaborate.

Need

Computational research in scientific (as opposed to industry) medical-related fields faces many obstacles, including (but not limited to):

data sharing

Within the ChRIS framework, data is managed and shared using services such as Swift/Ceph between various users of the system.

data protection

Data is protected on various levels by utilizing the isolation technologies of OpenShift including network isolation, container isolation utilizing namespaces and SELinux, and role level isolation that keep image plugins from escaping outside their linux container.

data visualization

Powerful javascript libraries are available for viewing and interacting with medical image data formats.

algorithm/program sharing

ChRIS is built on the idea of using containerized components that perform the actual analysis and processing. This standardizes application development and deployment for reuse.

re-use of existing programs in different environment

The pervasive use of container images allows for the easy re-use of analysis in many environments. The same container image that is run on a local laptop can be deployed out to a cloud resource.

access to powerful hardware

ChRIS is currently deployed to the Mass Open Cloud (MOC) and provides access to powerful resources including high-end GPUs.

realtime collaboration

The front end to ChRIS provides a powerful real time collaboration tool.

Deeper dive into how ChRIS works

To run medical image processing on ChRIS, a medical researcher/programmer encodes the algorithm that needs to be executed in the form of "plugin". The researcher/programmer then makes the plugin available via the ChRIS store. An administration of a ChRIS installation then makes the plugin available through their ChRIS installation. Once registered, users of the ChRIS system can use a plugin within their image analysis pipeline. Once execution of a plugin starts, pfcon, running at BCH datacenter, sends the data via pfioh and the algorithm to be applied on the data to pman. Pman and pfioh can run in a different datacenter (Ex: The MOC running OpenShift on top of OpenStack). Pman then translates the algorithm programmed in the plugin as Kubernetes job. To add scale to medical image processing, pman divides the job amongst several Kubernetes job pods that run in parallel. OpenShift provides the container platform for seamless orchestration and resource management on the cluster.

Architecture

Chris Architecture

A simplied, technical description of the components:

  • ChRIS_ui, the user interface
  • CUBE, the backend: manages user accounts, login, files, and data.
  • pfdcm connects CUBE to PACS servers.
  • A compute cluster is communicated to from CUBE via pfcon and pman.

Example: Multi-Party Computation with ChRIS

To understand ChRIS better, an example might help. You can learn more about this example from Dr. Ellen Grant’s talk at Red Hat Summit 2019

PACSPull Plugin

The above tree illustrates how a typical workflow looks in ChRIS. The nodes are various plugins that will be executed in ChRIS in the order of their hierarchy. The first node is for “PACS Pull” plugin. It pulls the MRI scan data for the workflow from BCH database into the computing environment, the MOC in this case. The output of this plugin is the input to the whole operation represented in the tree structure, a patient’s brain MRI.

PACS Pull Output

Next in chain is “FreeSurfer” plugin. It performs volume and surface based analysis of the MRI data and facilitates the visualization of the functional regions of the highly folded cerebral cortex.

Free Surfer Plugin 2D Output This is the 2D image output of FreeSurfer plugin. The colored regions depict various segments in the gray matter of the brain.

Free Surfer Plugin 3D Output This is the 3D image output of FreeSurfer plugin. The colored regions depict various segments in the gray matter of the brain.

Free Surfer Plugin Data table

FreeSurfer plugin also gives output in the format of a datatable. The first column consists of various segments in the cerebral cortex. The following columns gives Surface Area, Volume and Thickness of left and right hemispheres of the brain.

So what is MPC and how does it fit in “Brain Analysis”? Multiparty Computation (MPC) allows computation on encrypted values without sharing data entirely. Understanding rare diseases might require several hospitals to contribute their data toward image processing, and sharing patient data in the clear is restricted by privacy laws and hospital standard practices. Augmenting ChRIS with cryptographically secure multi-party computation allows multiple hospitals to jointly analyze data that they cannot observe individually. As a consequence, each hospital need not entrust other hospitals or the cloud vendor with its patient data. This MPC plugin compares a patient’s brain volume with the population data collected from two different hospitals. To achieve this ChRIS interacts with another open source project Conclave Cloud Dataverse or C2D. C2D uses OpenShift to provide isolated computing environment for MPC job pods.

MPC output

The above graph extrapolates the patient’s data (who is 10 years old) against the population mean for the segment “G_and_S_frontomargin” for various age groups. The blue line is for left hemisphere and the orange line is for right hemisphere. We can infer from the graph that the patient’s brain volume for both hemispheres is lower than the population mean volume for 10 years olds.

MPC output

It is also interesting to know which segments have significant deviation from the population mean in terms of brain volume for the same age group. From this graph one can find that for this patient there are 4 segments which have conspicuous deviation when compared to other 10 year olds.

MPC output

This view represents the raw data that made up the previous bar chart. It allows the radiologist/researcher to easily see how every brain segment compares to the population mean with helpful color coding for the largest deviations.

The last plugin “z2LabelMap” takes the zscore, output of MPC plugin, and creates a heat map by projecting the zscore as highlighted areas in the actual brain image.

MPC output

This image shows segments with the most conspicuous deviation from population mean. Blue regions depicts negative deviation and red ones positive deviation.

History

ChRIS has had several historical epochs:

bash shell scripts

The earliest versions of what would coalesce into ChRIS were collections of bash shell scripts that coordinated various types of analysis programs. This was prior to 2009/2010.

ChRIS v1

The first version of what would become ChRIS was created in 2010 and was built using Wt (web toolkit) from Emweb. It was geared to replacing the interface to the previous bash scripted system and interfaced with an in-house HPC for analysis.

ChRIS v2

The second version of ChRIS, released around 2013, replaced Wt with a cleaner, twitter-inspired interface built around the concept of feeds and plugins. This version of ChRIS interfaced primarily with HPC clusters. It is still in production use today.

ChRIS v3

The current development version of ChRIS features a complete redesign and shift to using REST-based services for distributed computing, and dockerized containers for data processing. In some contexts, this version of ChRIS is also called CHIPS.

Recent Papers

Some papers and conference proceedings on ChRIS -- please note in some papers the system is called CHIPS as the internal name for ChRIS v3:

Recent Talks

Some recent talks on ChRIS (please note there is much recycling on content below! I've added a quick note to the time length as a partial guide):

Red Hat Summit, “ChRIS and Multi-Party Compute” May 2019 (11 minutes)

Red Hat Summit, "Medical Image Processing with OpenShift and OpenStack" May 2018 (50 minutes)

National Alliance for Medical Computing, NA-MIC, Jan 2018 Project week talk (30 minutues)

Massachusetts Open Cloud (5 minutes)

Programming Links

Links to ChRIS components:

Main ChRIS engine:

Ancillary ChRIS services:

ChRIS plugin app store

ChRIS Frontend

Related Projects

Many projects simialr to ChRIS exist and have existed. They are called many things: Wikipedia calls them Scientific workflow systems or science gateways. Our documentation will often use the term "platform" or "compute platform."

We have an ever-outdated, hopefully-unbiased table of related projects here:

https://eminent-shirt-8f9.notion.site/3f3e69007196418c8d8e11753bd7e929?v=0a5a8a0a0ebc443b9e600111d9e72b1b

Old page (outdated info): https://github.com/FNNDSC/CHRIS_docs/wiki/Competitors/2542293b1f1a2436af9aa8f09aa62a5bcdf738ce

About

Documentation for CHRIS

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages