The gemma-client is a command-line tool for importing data into Signals Image Artist (SImA), compatible with both Linux and Windows operating systems. For an overview, please refer to Signals Image Artist: What is the gemma-client?
Uploading Data into a New Screen
You can create a new Screen in SImA during data upload by providing a unique (previously unused) screen_UUID
. Additionally, you can assign a name to the new Screen using the --screen-name
parameter.
Example Command
gemma-client upload --hostname <host> --username <user> --screen-name "<ScreenName>" <screen_UUID> "<data_format>" <path_to_import_data>
Parameter Descriptions
<host>
: IP address or domain name of the SImA server
<user>
: Username of the SImA account uploading the data
<ScreenName>
: Desired name for the new Screen
<screen_UUID>
: A new, unique UUID to assign to the Screen
<data_format>
: Format of the data being imported (e.g. Columbus IDX/TIF
, Harmony IDX/TIF
)
<path_to_import_data>
: Filesystem path to the dataset being uploaded
Real-World Example
gemma-client upload --hostname sima.host --username sarah --screen-name "MyScreen" $(uuidgen) "Harmony IDX/TIF" /data/import/harmony_dataset
In this example:
- The user
sarah
uploads 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.
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 SImA 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 <user>
Where the --owner-username
specifies the user with which the uploaded data will be associated.
Real-World Example
gemma-client upload --hostname sima.host --username admin --screen-name "MyScreen" $(uuidgen) "Harmony IDX/TIF" /data/import/harmony_dataset --owner-username sarah
In this example, the user admin
uploads data to a new Screen named MyScreen
on behalf of user sarah
.
Comments
0 comments
Article is closed for comments.