Difference between revisions of "Template:App Main"

From UFRC
Jump to navigation Jump to search
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
<noinclude>[[Category:Templates]]</noinclude><includeonly>[[Category:Software]]</includeonly>
 
<noinclude>[[Category:Templates]]</noinclude><includeonly>[[Category:Software]]</includeonly>
 
{|<!--CONFIGURATION: REQUIRED-->
 
{|<!--CONFIGURATION: REQUIRED-->
|{{#vardefine:app|DOUBLE_CLICK_TO_REPLACE}}
+
|{{#vardefine:app|REPLACE}}
|{{#vardefine:url|DOUBLE_CLICK_TO_REPLACE}}
+
|{{#vardefine:url|REPLACE}}
 
<!--CONFIGURATION: OPTIONAL (|1}} means it's ON)-->
 
<!--CONFIGURATION: OPTIONAL (|1}} means it's ON)-->
 
|{{#vardefine:conf|}}          <!--CONFIGURATION-->
 
|{{#vardefine:conf|}}          <!--CONFIGURATION-->
 
|{{#vardefine:exe|}}            <!--ADDITIONAL INFO-->
 
|{{#vardefine:exe|}}            <!--ADDITIONAL INFO-->
|{{#vardefine:pbs|}}            <!--PBS SCRIPTS-->
+
|{{#vardefine:job|}}            <!--JOB SCRIPTS-->
 
|{{#vardefine:policy|}}        <!--POLICY-->
 
|{{#vardefine:policy|}}        <!--POLICY-->
 
|{{#vardefine:testing|}}      <!--PROFILING-->
 
|{{#vardefine:testing|}}      <!--PROFILING-->
Line 18: Line 18:
 
{{App_Description|app={{#var:app}}|url={{#var:url}}|name={{#var:app}}}}|}}
 
{{App_Description|app={{#var:app}}|url={{#var:url}}|name={{#var:app}}}}|}}
  
Description goes here
+
DESCRIPTION
 +
 
 
<!--Modules-->
 
<!--Modules-->
==Required Modules==
+
==Environment Modules==
<!--
+
Run <code>module spider {{#var:app}}</code> to find out what environment modules are available for this application.
===Serial===
+
==System Variables==
* {{#var:app}}
+
* HPC_{{uc:{{#var:app}}}}_DIR - installation directory
===Parallel (OpenMP)===
 
* intel
 
* {{#var:app}}
 
===Parallel (MPI)===
 
* intel
 
* openmpi
 
* {{#var:app}}
 
-->
 
 
<!--Configuration-->
 
<!--Configuration-->
 
{{#if: {{#var: conf}}|==Configuration==
 
{{#if: {{#var: conf}}|==Configuration==
Line 38: Line 31:
 
<!--Run-->
 
<!--Run-->
 
{{#if: {{#var: exe}}|==Additional Information==
 
{{#if: {{#var: exe}}|==Additional Information==
 +
 
WRITE_ADDITIONAL_INSTRUCTIONS_ON_RUNNING_THE_SOFTWARE_IF_NECESSARY
 
WRITE_ADDITIONAL_INSTRUCTIONS_ON_RUNNING_THE_SOFTWARE_IF_NECESSARY
 +
 
|}}
 
|}}
<!--PBS scripts-->
+
<!--Job Scripts-->
{{#if: {{#var: pbs}}|==PBS Script Examples==
+
{{#if: {{#var: job}}|==Job Script Examples==
See the [[{{PAGENAME}}_PBS]] page for {{#var: app}} PBS script examples.
+
See the [[{{PAGENAME}}_Job_Scripts]] page for {{#var: app}} Job script examples.
 
|}}
 
|}}
 
<!--Policy-->
 
<!--Policy-->
 
{{#if: {{#var: policy}}|==Usage Policy==
 
{{#if: {{#var: policy}}|==Usage Policy==
 +
 
WRITE USAGE POLICY HERE (Licensing, usage, access).
 
WRITE USAGE POLICY HERE (Licensing, usage, access).
 +
 
|}}
 
|}}
 
<!--Performance-->
 
<!--Performance-->
 
{{#if: {{#var: testing}}|==Performance==
 
{{#if: {{#var: testing}}|==Performance==
 +
 
WRITE_PERFORMANCE_TESTING_RESULTS_HERE
 
WRITE_PERFORMANCE_TESTING_RESULTS_HERE
 +
 
|}}
 
|}}
 
<!--Faq-->
 
<!--Faq-->
Line 58: Line 57:
 
{{#if: {{#var: citation}}|==Citation==
 
{{#if: {{#var: citation}}|==Citation==
 
If you publish research that uses {{#var:app}} you have to cite it as follows:
 
If you publish research that uses {{#var:app}} you have to cite it as follows:
 +
 
WRITE_CITATION_HERE
 
WRITE_CITATION_HERE
 +
 
|}}
 
|}}
 
<!--Installation-->
 
<!--Installation-->

Latest revision as of 20:58, 6 December 2019

Description

[REPLACE REPLACE website]  

DESCRIPTION

Environment Modules

Run module spider REPLACE to find out what environment modules are available for this application.

System Variables

  • HPC_REPLACE_DIR - installation directory