Difference between revisions of "Template:App Main"
Jump to navigation
Jump to search
Moskalenko (talk | contribs) |
Moskalenko (talk | contribs) |
||
| Line 2: | Line 2: | ||
__NOEDITSECTION__ | __NOEDITSECTION__ | ||
<includeonly>[[Category:Software]]</includeonly> | <includeonly>[[Category:Software]]</includeonly> | ||
| − | <!-- | + | <!-- HELP: REQUIRED VARIABLES: |
| − | |||
| − | |||
app - lowercase name of the application e.g. "amber" | app - lowercase name of the application e.g. "amber" | ||
| − | url - | + | url - website e.g. "http://ambermd.org/" |
| − | + | HELP: OPTIONAL VARIABLES | |
INTEL - Version of the Intel Compiler e.g. "11.1" | INTEL - Version of the Intel Compiler e.g. "11.1" | ||
| − | MPI - MPI Implementation and version e.g. "openmpi/1.3.4" | + | MPI - MPI Implementation and version e.g. "openmpi/1.3.4"--> |
| − | --> | ||
{| | {| | ||
| − | <!-- | + | <!--CONFIGURATION: REQUIRED--> |
| − | |{{#vardefine:app| | + | |{{#vardefine:app|DOUBLE_CLICK_TO_CHANGE_THIS_NOW}} |
| − | |{{#vardefine:url| | + | |{{#vardefine:url|DOUBLE_CLICK_TO_CHANGE_THIS_NOW}} |
| − | <!-- | + | <!--CONFIGURATION: OPTIONAL--> |
| − | |{{#vardefine:intel|}} <!-- | + | |{{#vardefine:intel|}} <!-- "11.1" --> |
| − | |{{#vardefine:mpi|}} <!-- | + | |{{#vardefine:mpi|}} <!-- "openmpi/1.3.4" --> |
| − | + | |{{#vardefine:mod|1}} <!--MODULES --> | |
| − | |{{#vardefine:mod|1}} <!-- | + | |{{#vardefine:exe|}} <!--RUNNING --> |
| − | |{{#vardefine:exe|}} <!-- | + | |{{#vardefine:conf|}} <!--CONFIGS--> |
| − | |{{#vardefine:conf|}} <!-- | + | |{{#vardefine:pbs|}} <!--PBS SCRIPTS--> |
| − | |{{#vardefine:pbs|}} <!-- | + | |{{#vardefine:policy|}} <!--POLICY--> |
| − | |{{#vardefine:policy|}} <!-- | + | |{{#vardefine:testing|}} <!--TESTING/PROFILING--> |
| − | |{{#vardefine:testing|}} <!-- | + | |{{#vardefine:faq|}} <!--FAQ--> |
| − | |{{#vardefine:faq|}} <!-- | + | |{{#vardefine:citation|}} <!--CITATION--> |
| − | |{{#vardefine:citation|}} <!-- | ||
|} | |} | ||
| − | <!-- | + | <!--BODY--> |
<!--Description--> | <!--Description--> | ||
{{#if: {{#var: url}}| | {{#if: {{#var: url}}| | ||
{{App_Description|app={{#var:app}}|url={{#var:url}}}}|}} | {{App_Description|app={{#var:app}}|url={{#var:url}}}}|}} | ||
| − | + | DOUBLE_CLICK_TO_CHANGE_THIS_NOW | |
<!--Location--> | <!--Location--> | ||
{{App_Location|app={{#var:app}}|{{#var:ver}}}} | {{App_Location|app={{#var:app}}|{{#var:ver}}}} | ||
| − | <!-- | + | <!--VERSIONS-> |
==Available versions== | ==Available versions== | ||
| − | * | + | * DOUBLE_CLICK_TO_CHANGE_THIS_NOW |
<!-- --> | <!-- --> | ||
{{#if: {{#var: mod}}|==Running the application using modules== | {{#if: {{#var: mod}}|==Running the application using modules== | ||
{{App_Module|app={{#var:app}}|intel={{#var:intel}}|mpi={{#var:mpi}}}}|}} | {{App_Module|app={{#var:app}}|intel={{#var:intel}}|mpi={{#var:mpi}}}}|}} | ||
| + | <!--Add additional HPC_FOO_BIN and other ENV variables below--> | ||
| + | <!--Run--> | ||
{{#if: {{#var: exe}}|==How To Run== | {{#if: {{#var: exe}}|==How To Run== | ||
| − | + | DOUBLE_CLICK_TO_WRITE_INSTRUCTIONS_ON_RUNNING_THE_ACTUAL_BINARY|}} | |
| + | <!--Configuration--> | ||
{{#if: {{#var: conf}}|==Configuration== | {{#if: {{#var: conf}}|==Configuration== | ||
See the [[{{PAGENAME}}_Configuration]] page for {{#var: app}} configuration details.|}} | See the [[{{PAGENAME}}_Configuration]] page for {{#var: app}} configuration details.|}} | ||
| + | <!--PBS scripts--> | ||
{{#if: {{#var: pbs}}|==PBS Script Examples== | {{#if: {{#var: pbs}}|==PBS Script Examples== | ||
See the [[{{PAGENAME}}_PBS]] page for {{#var: app}} PBS script examples.|}} | See the [[{{PAGENAME}}_PBS]] page for {{#var: app}} PBS script examples.|}} | ||
| + | <!--Policy--> | ||
{{#if: {{#var: policy}}|==Usage policy== | {{#if: {{#var: policy}}|==Usage policy== | ||
WRITE USAGE POLICY HERE (perhaps templates for a couple of main licensing schemes can be used)|}} | WRITE USAGE POLICY HERE (perhaps templates for a couple of main licensing schemes can be used)|}} | ||
| + | <!--Performance--> | ||
{{#if: {{#var: testing}}|==Performance== | {{#if: {{#var: testing}}|==Performance== | ||
| − | + | DOUBLE_CLICK_TO_WRITE_PERFORMANCE_TESTING_RESULTS_HERE|}} | |
| + | <!--Faq--> | ||
{{#if: {{#var: faq}}|==FAQ== | {{#if: {{#var: faq}}|==FAQ== | ||
*'''Q:''' **'''A:'''|}} | *'''Q:''' **'''A:'''|}} | ||
| + | <!--Citation--> | ||
{{#if: {{#var: citation}}|==Citation== | {{#if: {{#var: citation}}|==Citation== | ||
If you publish research that uses {{{app}}} you have to cite it as follows: | If you publish research that uses {{{app}}} you have to cite it as follows: | ||
| − | + | DOUBLE_CLICK_TO_WRITE_CITATION_HERE | |
|}} | |}} | ||
Revision as of 04:07, 12 May 2012
Description
[DOUBLE_CLICK_TO_CHANGE_THIS_NOW {{{name}}} website]
DOUBLE_CLICK_TO_CHANGE_THIS_NOW
Template:App Location
Running the application using modules
To use DOUBLE_CLICK_TO_CHANGE_THIS_NOW with the environment modules system at HPC the following commands are available:
Get module information for app main:
$module spider DOUBLE_CLICK_TO_CHANGE_THIS_NOW
Load the default application module:
$module load DOUBLE_CLICK_TO_CHANGE_THIS_NOW
The modulefile for this software adds the directory with executable files to the shell execution PATH and sets the following environment variables:
- HPC_DOUBLE_CLICK_TO_CHANGE_THIS_NOW_DIR - directory where DOUBLE_CLICK_TO_CHANGE_THIS_NOW is located.