Page History

On 10/5/18, Ruth drafted the above instructions based on instructions in section 3.3 of the DME User Guide in GitHub. On 1/8/19, Zhengwu suggested following the Getting Started guide in GitHub instead.

Notes on the instructions in the above readme: 

• Save the hpcdme.properties file (the copy of hpcdme.properties-sample) to the same folder. 
• No need to edit the server lines. Just Uncomment the lines for the server: either Production or UAT.
• Define the environment variable HPC_DM_UTILS as a system environment variable if possible. Otherwise, define it as a user environment variable.  
• The sed command (for Windows) seems to change the line endings in the functions file.
• The export command seems to be preparation for the source command. 
• The source command seems to run the functions file.
• The functions file has comments explaining each command it contains:
  • An export command that adds the utilities (the scripts folder) to the PATH environment variable.
  • Two sed commands (for Windows) that change the line endings in each file in the scripts folder and the line endings in the hpcdme.properties-sample file.

Questions:

• Why not change line endings in the hpcdme.properties file, too?
• Should these instructions be moved from the readme to this wiki?
  

Comparison of CLU setup instructions in the User Guide and the readme versus the Getting Started Guide in GitHub:

• Both guides recommend running java -version. The User Guide specifies which java version is required, but Getting Started does not.
• Getting Started specifies Curl 7.5.4 or above as a prerequisite, but the User Guide does not.
• Both guides recommend Cygwin if using Windows. (On 1/8/19, Zhengwu recommended installing all curl and java packages available in the Cygwin installation wizard. Neither guide mentions Cygwin packages.)
  
• Both guides specify a git clone command. Getting Started has .git at the end, but the User Guide does not.
• The User Guide refers to the readme for further instructions after the git clone command. The Getting Started seems self-contained.
• The readme says to copy the hpcdme.properties-sample file. Getting Started says to copy or rename it, but then recommends making a backup copy before editing.
• Both the readme and Getting Started have instructions for specifying hpc.server.url, hpc.user, and hpc.default.globus.endpoint, but those instructions in Getting Started are more clear.
• Getting Started has instructions for specifying hpc.ssl.keystore.password and other properties, but the readme does not.
• Both the readme and Getting Started have instructions to run the sed command (for Windows) to change the line endings in the functions file, but the wording in Getting Started is more clear.
• The readme has an optional step involving curl-conf-sample, but Getting Started does not.
• The readme says to define the HPC_DM_UTILS environment variable, but Getting Started does not.
• Both the readme and Getting Started describe adding export and source commands to ~/.bashrc or ~/.profile file, but the wording in Getting Started is more clear. (On 1/8/19, Zhengwu recommended having the export, sed, and source commands in an eol_set.sh file; and recommended having cd, in addition to having them in export, sed, & source in the .bashrc file & two of them in the functions file.)
• Getting Started has an additional source command to make changes take effect. The readme doesn't have this step.
• Getting Started has a step for the dm_generate_token command, but the readme does not.
  

Questions:

• Why duplicate the commands? Why do we need the export, sed, and source commands in both an eol_set.sh file and the .bashrc file?