How to Run a Reference Pipeline using Local Input Files

Download & Install the Pipeline from NGC

Please refer to Setup section to install this Pipeline.

Note down the pipeline ID during the pipeline installation as it would be used in a later section to trigger a job with input files.

Trigger Pipeline

A pipeline can be triggered via Clara CLI. To trigger this pipeline, you will need to have a volume image in MetaIO format (.mhd and .raw) and a configuration file for Render Server (config_render.json) that can be used as source input data.

For this created pipeline, sample input files are available in the zipped test data file. Let's say that the path of the unzipped test data folder is TEST_DATA_FOLDER.

Open a terminal and go to the pipeline directory which has pipeline definition file as well as test input/model folder.

cd /path-to-pipeline-folder/

Trigger the pipeline (upload input files to Clara API Server) with the pipeline ID in the previous section.

clara create jobs -n fastio-itk-test -p <pipeline ID> -f <TEST_DATA_FOLDER>/

When the above step is completed, you should be able to see the following result in the terminal (UUID of Job and Payload will be different).

JOB_ID: daa5aea74d1446a8a24b9d3990bfef67
PAYLOAD_ID: 79aa5500e6134cf888f1d6d89f2e249e

Note down this job ID and payload ID as they would be used in a later section to access output files.

Then, start the job:

# Start a job with a parameter `CROP_START_X=230` and `CROP_SIZE_Z=300`
clara start job -j <JOB ID> -a CROP_START_X=230 -a CROP_SIZE_Z=300

Check Job Status and Download/View Payloads in Clara Console/Dashboard

With Clara Orchestrator (API version >= 0.4.0)

Go to the Clara Management Console using a web browser: The URL is: <IP of the machine>:32002
Go to the JOBS view. You should see a job with a name that includes the name of the job you specified
You can inspect the status of each operator inside that job

Please check Clara Management Console to see the web application in detail.

With Argo Orchestrator (API version <= 0.3.0)

Go to the Clara dashboard UI using a web browser: The URL is <machine-ip>:8000.

You should see a job with a name that includes the name of the pipeline you created.
You can inspect the status of each operator inside that job

Viewing the Output Volume Image

Go to the Clara RenderServer UI using a web browser: The URL is: <IP of the machine>:8080
You should see a dataset with a name that includes the name of the job you specified and the operator name (e.g., fastio-itk-test-write-volume)
Clicking the dataset would show the rendered image on the screen

Download and Verify the Outputs

Once the job has completed successfully, we can download output payload by using clara download command.

Output payload files are located under /operators/<operator name defined in the pipeline definition>/ folder. Since we triggered a pipeline whose volume output operator's name is write-volume, we can use the following command to download output files into result folder:

clara download <Job ID>:/operators/write-volume/* result

Then, you can see the output files using the following command:

ls -al result

If you are working with the server machine, the payload folder is directly accessible at the default payload folder /clara/payloads/<Payload ID>/.