Applications Information for NGS Site Admin Installers

NGS Sites will usually use the following work flow when installing a scientific application (Eg NAMD, DLPOLY ) and making it available for NGS users via UEE (Uniform Execution Environment).

• 1/ Install the app.
• 2/ Create a module file (if your site supports environment modules)
• 3/ Create a UEE in /usr/ngs
  • Use API from http://www.ngs.ac.uk/applications/UEE-APIor, if the lead site, create a new one and update this page. There is more information on UEEs.
• 4/ Test the application using:
  • Launched locally and via globus.
  • From the WMS and (if lead site) create an example JDL file.
  • From the NGS portal template or (if lead site) createa a new template. .
    • https://portal.ngs.ac.uk
• 5/ Create documentation
  • Use template here as a starting point:
    

           http://www.ngs.ac.uk/applications/blanktemplate

    The page should allow a user to follow the instructions to run this app on any NGS site having the code installed. Any site specifics (eg Specific compilation options used) can be included at the bottom of the page.

  • Following the conventions allows the www.ngs.ac.uk/applications page to automatically match a new application seen in the BDII to its category and documentation page. Specifically:
    • URL should be set to applications/<category>/<uee-name-in-lowercase>
    • Should appear in the menus under the relevant category eg applications/bioinformatics/<app-name>
    • Add a hyperlink to the list at the top of the relevant category page eg applications/bioinformatics page
• 6/ Create unix group or add to s/w VO if the app has license restrictions.
  • Restrict access to both exe and source.
• 7/ (If lead installer): Ideally create installer script and mail NGS-OPS list with details.
  • Shows the steps and compilation options for other sites to copy/ amend.
• 8/ Update any helpdesk tickets so requesting user knows its installed.