Image Artist: Using the gemma-client to Register External Data

The gemma-client is a command-line tool for importing data into Image Artist, compatible with both Linux and Windows operating systems. For an overview, please refer to Image Artist: What is the gemma-client?

Registering Data Stored in an External Bucket

You can use the gemma-client to register datasets which are stored in an external S3 bucket, instead of uploading them into Image Artist's internal storage. This method allows Image Artist to directly access the data in the external bucket, significantly reducing the time required to make datasets available.

Example command

gemma-client register --no-verify --hostname <host> --no-warnings --username <user> <UUID> "<data_format>" <s3://path-to-dataset> --screen-name <screen_name>

Parameter Descriptions

Real-World example

gemma-client register --no-verify --hostname imageartist.host --username sarah $(uuidgen) "Harmony IDX/TIF" s3://externalBucket/HarmonyDataset/ --screen-name "MyScreen"

In this example:

• The user sarah registers the data to a new Screen named "MyScreen"
• The Linux uuidgen program was used to generate the Screen UUID. The uuidgen program creates a new universally unique identifier (UUID) using the libuuid library. Similar UUID generators could be used when working with the gemma-client in a Windows environment. 

Registering on behalf of another user (Admin Only): 

Administrators can register data on behalf of another user using the --owner-username parameter.

Example Command

gemma-client register --no-verify --hostname <host> --no-warnings --username <admin_user> <UUID> "<data_format>" <s3://path-to-dataset> --screen-name <screen_name> --owner-username <user_name>

Where the --owner-username specifies the user with which the registered data will be associated. 

Real-World example

gemma-client register --no-verify --hostname imageartist.host --username admin $(uuidgen) "Harmony IDX/TIF" s3://externalBucket/HarmonyDataset/ --screen-name "MyScreen" --owner-username sarah

In this example, the user admin registers data to a new Screen named MyScreen on behalf of user sarah.