Template:App Main: Difference between revisions

From UFRC
Jump to navigation Jump to search
← Older edit
No edit summary
No edit summary
 
(24 intermediate revisions by the same user not shown)
Line 1: Line 1:
__NOTOC____NOEDITSECTION__
<noinclude>[[Category:Templates]]</noinclude><includeonly>[[Category:Software]]</includeonly>
<includeonly>[[Category:Software]]</includeonly>
{|<!--CONFIGURATION: REQUIRED-->
<!-- HELP: REQUIRED VARIABLES:
|{{#vardefine:app|REPLACE}}
app - lowercase name of the application e.g. "amber"
|{{#vardefine:url|REPLACE}}
url - website e.g. "http://ambermd.org/"
<!--CONFIGURATION: OPTIONAL (|1}} means it's ON)-->
        HELP: OPTIONAL VARIABLES
|{{#vardefine:conf|}}           <!--CONFIGURATION-->
INTEL - Version of the Intel Compiler e.g. "11.1"
|{{#vardefine:exe|}}           <!--ADDITIONAL INFO-->
MPI - MPI Implementation and version e.g. "openmpi/1.3.4"-->
|{{#vardefine:job|}}           <!--JOB SCRIPTS-->
{|
|{{#vardefine:policy|}}         <!--POLICY-->
<!--CONFIGURATION: REQUIRED-->
|{{#vardefine:testing|}}       <!--PROFILING-->
|{{#vardefine:app|DOUBLE_CLICK_TO_CHANGE_THIS_NOW}}<--    APP NAME    -->
|{{#vardefine:faq|}}             <!--FAQ-->
|{{#vardefine:url|DOUBLE_CLICK_TO_CHANGE_THIS_NOW}}<--    WEBSITE    -->
|{{#vardefine:citation|}}       <!--CITATION-->
<!--CONFIGURATION: OPTIONAL-->
|{{#vardefine:installation|}} <!--INSTALLATION-->
|{{#vardefine:intel|}} <!-- "11.1" -->
|{{#vardefine:mpi|}} <!-- "openmpi/1.3.4" -->
|{{#vardefine:mod|1}} <!--MODULES -->
|{{#vardefine:exe|}} <!--RUNNING -->
|{{#vardefine:conf|}} <!--CONFIGS-->
|{{#vardefine:pbs|}} <!--PBS SCRIPTS-->
|{{#vardefine:policy|}} <!--POLICY-->
|{{#vardefine:testing|}} <!--TESTING/PROFILING-->
|{{#vardefine:faq|}} <!--FAQ-->
|{{#vardefine:citation|}} <!--CITATION-->
|}
|}
<!--BODY-->
<!--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}}|name={{#var:app}}}}|}}
DOUBLE_CLICK_TO_CHANGE_THIS_NOW
 
<!--Location-->
DESCRIPTION
{{App_Location|app={{#var:app}}|{{#var:ver}}}}
 
<!--VERSIONS-->
<!--Modules-->
==Available versions==
==Environment Modules==
* DOUBLE_CLICK_TO_CHANGE_THIS_NOW
Run <code>module spider {{#var:app}}</code> to find out what environment modules are available for this application.
<!-- -->
==System Variables==
{{#if: {{#var: mod}}|==Running the application using modules==
* HPC_{{uc:{{#var:app}}}}_DIR - installation directory
{{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==
DOUBLE_CLICK_TO_WRITE_INSTRUCTIONS_ON_RUNNING_THE_ACTUAL_BINARY|}}
<!--Configuration-->
<!--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==
<!--Run-->
See the [[{{PAGENAME}}_PBS]] page for {{#var: app}} PBS script examples.|}}
{{#if: {{#var: exe}}|==Additional Information==
 
WRITE_ADDITIONAL_INSTRUCTIONS_ON_RUNNING_THE_SOFTWARE_IF_NECESSARY
 
|}}
<!--Job Scripts-->
{{#if: {{#var: job}}|==Job 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 (perhaps templates for a couple of main licensing schemes can be used)|}}
 
WRITE USAGE POLICY HERE (Licensing, usage, access).
 
|}}
<!--Performance-->
<!--Performance-->
{{#if: {{#var: testing}}|==Performance==
{{#if: {{#var: testing}}|==Performance==
DOUBLE_CLICK_TO_WRITE_PERFORMANCE_TESTING_RESULTS_HERE|}}
 
WRITE_PERFORMANCE_TESTING_RESULTS_HERE
 
|}}
<!--Faq-->
<!--Faq-->
{{#if: {{#var: faq}}|==FAQ==
{{#if: {{#var: faq}}|==FAQ==
Line 57: Line 56:
<!--Citation-->
<!--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 {{#var:app}} you have to cite it as follows:
DOUBLE_CLICK_TO_WRITE_CITATION_HERE
 
WRITE_CITATION_HERE
 
|}}
|}}
<!--Installation-->
{{#if: {{#var: installation}}|==Installation==
See the [[{{PAGENAME}}_Install]] page for {{#var: app}} installation notes.|}}
<!--Turn the Table of Contents and Edit paragraph links ON/OFF-->
__NOTOC____NOEDITSECTION__

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





Retrieved from "https://help.rc.ufl.edu/mediawiki/index.php?title=Template:App_Main&oldid=18521"