13.1.2. Setup

This section will walk you through setting up Clara DICOM Adapter, using the Clara Deploy AI COVID-19 Classification Pipeline as an example.

To install Clara DICOM Adapter Helm Chart, please follow these steps:

  1. If the system doesn’t already have Docker and Kubernetes installed, first run the Bootstrap script.
  2. Install Clara Deploy CLI.
  3. Install Clara DICOM Adapter Helm Chart using the following command:

$ clara pull dicom

Next, we’ll configure Clara DICOM Adapter.

The DICOM Adapter configuration is stored as JSON in ~/.clara/charts/dicom-adapter/files/appsettings.json. The default settings enable DICOM C-STORE SCP and C-STORE-SCU and set listening on port 104. For a complete reference, refer to DICOM Configuration Schema. Default Settings (appsettings.json)


{ "DicomAdapter": { "readAeTitlesFromCrd": true, "dicom": { "scp": { "port": 104, "log-dimse-datasets": false, "reject-unknown-sources": true }, "scu": { "ae-title": "ClaraSCU", "log-dimse-datasets": false, "log-data-pdus": false } }, "storage" : { "temporary" : "/payloads" } }, "Serilog": { "Using": [ "Serilog.Sinks.Console" ], "MinimumLevel": "Information", "WriteTo": [ { "Name": "Console", "Args": { "theme": "Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme::Code, Serilog.Sinks.Console", "outputTemplate": "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u4}] [{MachineName}] {SourceContext}[{ThreadId}] {Properties} {Message:l}{NewLine}{Exception}" } }, { "Name": "File", "Args": { "path": "logs/clara-dicom.log", "rollingInterval": "Day", "rollOnFileSizeLimit": true, "outputTemplate": "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u4}] [{MachineName}] {SourceContext}[{ThreadId}] {Properties} {Message}{NewLine}{Exception}" } } ], "Enrich": [ "FromLogContext", "WithMachineName", "WithThreadId" ] }, "Logging": { "LogLevel": { "Default": "Information", "Microsoft": "Warning", "Microsoft.Hosting.Lifetime": "Information", "Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker": "Error" } }, "AllowedHosts": "*" }

Once you have configured Clara DICOM Adapter, run the following command to start the service:


clara dicom start

Before setting up a new Clara AE Title, you must first register the COVID-19 pipeline: Refer to the COVID-19 Setup Guide to register the pipeline.

Once you have registered the pipeline with Clara Platform and have the Pipeline ID, you can now setup a new Clara AE Title to accept DICOM associations and store DICOM instances.

First, create a new Clara AE Title:


$ clara dicom create aetitle -a COVIDAET pipeline-covid=<PIPELINE-ID>


Per the DICOM standard, the length of the ae-Title value should not exceed 16 characters.

Next, create a DICOM Source to allow that DICOM device to communicate with DICOM Adapter:


$ clara dicom create -a MYPACS -i

Now you have a DICOM device with the AE Title MYPACS registered at IP address, and Clara DICOM Adapter will now accept DICOM associations from this device.


If you would like DICOM Adapter to accept any incoming DICOM association without verifying the source, you may set DicomAdapter>dicom>scp>reject-unknown-sources to false in the configuration file.

If the pipeline (in this case, the COVID-19 pipeline) generates results in DICOM format and needs to export the results back to a DICOM device, e.g. PACS, you will need to create a DICOM destination:


$ clara dicom create dest -n MYPACS -a MYPACSAET -i -p 1104

With the command and arguments above, we have created a new DICOM Destination named MYPACS with AE Title MYPACSAET at IP address and port 1104. Please note that the name argument (-n) must match the arguments defined in the pipeline. Please refer to Register Results Operator for a complete reference.

With all the steps completed above, Clara DICOM Adapter is now ready to receive DICOM associations with the AE Title COVIDAET. To summarize, you’ve done the following:

  1. Install Clara DICOM Adapter Helm Chart
  2. Register COVID-19 pipeline with Clara
  3. Setup Clara AE Title to run the COVID-19 pipeline
  4. Setup DICOM Source to allow incoming association requests
  5. Setup DICOM Destination for exporting processed results Helm Chart Storage Configuration

The DICOM Adapter helm chart by default creates a persistent volume claim with 50Gi on /clara-io/clara-core/payloads, which is mounted to /payloads inside the DICOM Adapter container.

To increase or decrease the size of the volume claim, find and modify the volumeSize property in ~/.clara/charts/dicom-adapter/values.yaml and restart the DICOM Adapter.

© Copyright 2018-2020, NVIDIA Corporation. All rights reserved. Last updated on Feb 1, 2023.