This repository contains the data, code, scripts and configuration files associated with the Getting Started tutorial in the QMENTA SDK documentation portal.
The tutorial helps you learn the foundations of using the QMENTA SDK and the technological ecosystem around it, including Docker and the QMENTA platform.
As a case study, the tutorial goes over the implementation of a tool that takes as input a T1 anatomical image in DICOM format and converts it to NIfTI or MGZ format. This simple tool illustrates the following SDK capabilities:
- Download files from platform
- Define parameters
- Upload files into the platform
- Set metadata values
The tool is ready to test locally by running a simple command. First, make the script executable:
chmod +x test_local_sdk.shAnd execute it
./test_local_sdk.shOnce the local testing has been successfully run, you can create the docker image using the following. Update the image name and version:
docker build -t image_name:version .The next step is to test the tool locally using the docker image you just created. To perform this operation, use the script provided running the following. Update again the image name and version:
python test_container_sdk.py --settings settings.json --values settings_values.json image_name:version data/input data/output/The tool will run inside the container and provide the output files in the /data/output folder
If the tool finishes successfully, you can push the docker image into your repository. First, tag it using the registry hostname from the repository, for example, if the registry is in https://hub.docker.com/repositories/qmenta then:
docker tag image_name:version qmenta/image_name:versionThen you can push it using the set tag.
docker push qmenta/image_name:versionNow you can create the tool on the QMENTA platform using that tag as image name.
Now that you have seen the SDK tool development pipeline, we encourage you to try implement your own. Follow the steps described here and check Getting Started tutorial in the QMENTA SDK documentation portal to get more information.