This page is a work in progress. |
If you decide to use the CLU to perform various activities in DME, the following steps are pre-requisites:
Check whether you have performed the previous steps correctly: In a cmd, shell, or Cygwin window, type the following command. The command output should display the version of Java you intended to install:
java –version |
In a cmd or shell window, type the following command to clone DME utilities to your local machine:
Git clone https://github.com/CBIIT/HPC_DME_APIs |
In the HPC_DME_APIs\utils\ folder, create a copy of the sample configuration file (hpcdme.properties-sample) and rename it (as hpcdme.properties). Edit your hpcdme.properties file to make the following configuration changes:
Property | Instructions |
---|---|
Server settings | If you want to connect to the Production tier, uncomment the Production server settings and comment out the UAT server settings. By default, the UAT server settings are enabled. |
hpc.ssl.keystore.password | Contact NCIDataVault@mail.nih.gov to request this password. |
hpc.user | Specify your NIH username. |
hpc.default.globus.endpoint | If you intend to use the Globus integration, specify the UUID of the Globus endpoint that you want to use. |
hpc.globus.user | If you intend to use the Globus integration, specify your Globus username. |
Other properties not mentioned above | These properties are for special cases and internal use only. If you have questions about these properties, contact NCIDataVault@mail.nih.gov. |
.
Configure environment variables:
Navigate to your ~/.bashrc or ~/.profile file, where ~ represents your home directory. For example:
C:\cygwin64\home\<username> |
Edit your ~/.bashrc or ~/.profile file to append following commands, where <client_utils_home> is the absolute path to the HPC_DME_APIs\utils\ folder. The following commands define the HPC_DM_UTILS environment variable and update the PATH environment variable to include the path to the scripts folder:
export HPC_DM_UTILS="<client_utils_home>" export PATH=$HPC_DM_UTILS/scripts/:$PATH |
If you are using Cygwin on Windows, run the following commands in Cygwin to change end of line delimiters from Windows standard to Unix standard in any files involved in CLU setup:
Adjust the line delimiters in the file with your export commands (~/.bashrc or ~/.profile). For example:
sed -i "s/\r$//" ~/.bashrc |
To make the above line delimiter changes take effect in current Bash session, source the modified file (~/.bashrc or ~/.profile). For example:
source ~/.bashrc |
Adjust the line delimiters in all files in the scripts folder. Use the following command:
sed -i "s/\r$//" $HPC_DM_UTILS/scripts/* |
Run the following command to generate a DME API authentication token. With this token, you avoid repeatedly typing your password for every command requiring authentication to DME API server:
dm_generate_token |
If you intend to use the Globus integration, run the following command to generate a Globus token:
dm_globus_generate_token |
For instructions on other DME CLU commands, refer to the User Guide in the following location:
https://github.com/CBIIT/HPC_DME_APIs/tree/master/doc/guides
For instructions on other DME CLU commands, refer to the following pages: |