Template:App Main: Difference between revisions

From UFRC
Jump to navigation Jump to search
Created page with "<noinclude> Category:Templates __NOTOC__ __NOEDITSECTION__ =Background= Wiki_Software_Info </noinclude> __NOTOC__ __NOEDITSECTION__ Category:Software <!-- ######## T…"
 
No edit summary
 
(34 intermediate revisions by the same user not shown)
Line 1: Line 1:
<noinclude>
<noinclude>[[Category:Templates]]</noinclude><includeonly>[[Category:Software]]</includeonly>
[[Category:Templates]]
{|<!--CONFIGURATION: REQUIRED-->
__NOTOC__
|{{#vardefine:app|REPLACE}}
__NOEDITSECTION__
|{{#vardefine:url|REPLACE}}
=Background=
<!--CONFIGURATION: OPTIONAL (|1}} means it's ON)-->
[[Wiki_Software_Info]]
|{{#vardefine:conf|}}           <!--CONFIGURATION-->
</noinclude>
|{{#vardefine:exe|}}           <!--ADDITIONAL INFO-->
__NOTOC__
|{{#vardefine:job|}}           <!--JOB SCRIPTS-->
__NOEDITSECTION__
|{{#vardefine:policy|}}         <!--POLICY-->
[[Category:Software]]
|{{#vardefine:testing|}}       <!--PROFILING-->
<!-- ########  Template Configuration ######## -->
|{{#vardefine:faq|}}             <!--FAQ-->
<!--Edit definitions of the variables used in template calls
|{{#vardefine:citation|}}       <!--CITATION-->
Required variables:
|{{#vardefine:installation|}} <!--INSTALLATION-->
app - lowercase name of the application e.g. "amber"
url - url of the software page (project, company product, etc) - e.g. "http://ambermd.org/"
Optional variables:
INTEL - Version of the Intel Compiler e.g. "11.1"
MPI - MPI Implementation and version e.g. "openmpi/1.3.4"
-->
{|
<!--Main settings - REQUIRED-->
|{{#vardefine:app|test}}
|{{#vardefine:url|http://sourceforge.net}}
<!--Compiler and MPI settings - OPTIONAL -->
|{{#vardefine:intel|}} <!-- E.g. "11.1" -->
|{{#vardefine:mpi|}} <!-- E.g. "openmpi/1.3.4" -->
<!--Choose sections to enable - OPTIONAL-->
|{{#vardefine:mod|1}} <!--Present instructions for running the software with modules -->
|{{#vardefine:exe|}} <!--Present manual instructions for running the software -->
|{{#vardefine:conf|}} <!--Enable config wiki page link - {{#vardefine:conf|1}} = ON/conf|}} = OFF-->
|{{#vardefine:pbs|}} <!--Enable PBS script wiki page link-->
|{{#vardefine:policy|}} <!--Enable policy section -->
|{{#vardefine:testing|}} <!--Enable performance testing/profiling section -->
|{{#vardefine:faq|}} <!--Enable FAQ section -->
|{{#vardefine:citation|}} <!--Enable Reference/Citation section -->
|}
|}
<!-- ########  Template 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}}}}|}}
PASTE OR ENTER EXTENDED DESCRIPTION HERE OR REMOVE THIS LINE
 
[PASTE A LINK TO UPSTREAM DOCS OR REMOVE THIS LINE Upstream documentation] for {{{app}}}.
DESCRIPTION
<!--Location-->
 
{{App_Location|app={{#var:app}}|{{#var:ver}}}}
<!--Modules-->
ADD EXECUTABLE AND LIBRARY LOCATION DETAILS FOR INSTALLED VERSIONS OR REMOVE THIS MESSAGE
==Environment Modules==
<!-- -->
Run <code>module spider {{#var:app}}</code> to find out what environment modules are available for this application.
{{#if: {{#var: mod}}|==Running the application using modules==
==System Variables==
{{App_Module|app={{#var:app}}|intel={{#var:intel}}|mpi={{#var:mpi}}}}|}}
* HPC_{{uc:{{#var:app}}}}_DIR - installation directory
{{#if: {{#var: exe}}|==Manual execution instructions==
<!--Configuration-->
WRITE INSTRUCTIONS ON RUNNING THE APP WITHOUT MODULES HERE|}}
{{#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.
{{#if: {{#var: pbs}}|==PBS Script Examples==
|}}
See the [[{{PAGENAME}}_PBS]] page for {{#var: app}} PBS script examples.|}}
<!--Run-->
{{#if: {{#var: policy}}|==Usage policy==
{{#if: {{#var: exe}}|==Additional Information==
WRITE USAGE POLICY HERE (perhaps templates for a couple of main licensing schemes can be used)|}}
 
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-->
{{#if: {{#var: policy}}|==Usage Policy==
 
WRITE USAGE POLICY HERE (Licensing, usage, access).
 
|}}
<!--Performance-->
{{#if: {{#var: testing}}|==Performance==
{{#if: {{#var: testing}}|==Performance==
WRITE PERFORMANCE TESTING RESULTS HERE|}}
 
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 {{#var:app}} you have to cite it as follows:
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"