Image Artist: Using the gemma client to upload into an existing screen

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?

Uploading Data into an Existing Screen

You can upload data to an existing Screen in Image Artist by specifying the Screen’s unique ID during job submission. This ensures the data is correctly associated with the target Screen. For instructions on locating a Screen UUID in the Image Artist web interface, refer to: Image Artist: How do I identify the Screen, Plate or Measurement UUID via the web interface?

Example Command

gemma-client upload --hostname <host> --username <user> <screen_UUID> "<data_format>" <path_to_import_data>

Parameter Descriptions

Real-World Example

gemma-client upload --hostname imageartist.host --username sarah 85dd7f6f-99e8-4d4a-a51e-32f22c40a7e2 "Harmony IDX/TIF" /data/import/harmony_dataset

In this example, the user sarah uploads data to the Screen UUID 85dd7f6f-99e8-4d4a-a51e-32f22c40a7e2.

Authentication Note

• The password for the specified <user> will be requested interactively at runtime.
• Alternatively, you can pass the password using the --password option. 

Uploading on behalf of another user (Admin Only): 

As of Image Artist v1.2, administrators can upload data on behalf of another user using the --owner-username parameter.

Example command

gemma-client upload --hostname <host> --username <admin_user> <screen_UUID> "<data_format>" <path_to_import_data> --owner-username <data_owner>

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

Real-World Example

gemma-client upload --hostname imageartist.host --username admin 85dd7f6f-99e8-4d4a-a51e-32f22c40a7e2 "Harmony IDX/TIF" /data/import/harmony_dataset --owner-username sarah

In this case, the user admin uploads data to the Screen UUID 85dd7f6f-99e8-4d4a-a51e-32f22c40a7e2 on behalf of user sarah.