Difference between revisions of "Example"

From UFRC
Jump to navigation Jump to search
m (Text replacement - "#uppercase" to "uc")
(4 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
{|<!--CONFIGURATION: REQUIRED-->
 
{|<!--CONFIGURATION: REQUIRED-->
 
|{{#vardefine:app|foobarbaz}}
 
|{{#vardefine:app|foobarbaz}}
|{{#vardefine:url|http://wiki.hpc.ufl.edu}}
+
|{{#vardefine:url|http://wiki.rc.ufl.edu}}
 
<!--CONFIGURATION: OPTIONAL (1=ON)-->
 
<!--CONFIGURATION: OPTIONAL (1=ON)-->
 
|{{#vardefine:mod|1}} <!--MODULES - NOW REQUIRED-->
 
|{{#vardefine:mod|1}} <!--MODULES - NOW REQUIRED-->
Line 9: Line 9:
 
|{{#vardefine:exe|1}} <!--RUNNING -->
 
|{{#vardefine:exe|1}} <!--RUNNING -->
 
|{{#vardefine:conf|1}} <!--CONFIGS-->
 
|{{#vardefine:conf|1}} <!--CONFIGS-->
|{{#vardefine:pbs|1}} <!--PBS SCRIPTS-->
+
|{{#vardefine:pbs|}} <!--PBS SCRIPTS-->
 
|{{#vardefine:policy|1}} <!--POLICY-->
 
|{{#vardefine:policy|1}} <!--POLICY-->
 
|{{#vardefine:testing|1}} <!--TESTING/PROFILING-->
 
|{{#vardefine:testing|1}} <!--TESTING/PROFILING-->
Line 35: Line 35:
 
*openmpi  
 
*openmpi  
 
*foobarbaz
 
*foobarbaz
 +
==System Variables==
 +
* HPC_FOOBARBAZ_DIR
 
<!--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.
 
|}}
 
|}}
 +
==System Variables==
 +
* HPC_{{uc:{{#var:app}}}}_DIR - installation directory
 
<!--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

Revision as of 21:20, 6 December 2019

Description

foobarbaz website  


The software foobarbaz is a really wonderful tool that lets you tie your shoelaces remotely.

Required Modules

modules documentation

Serial

  • foobarbaz

Parallel (OpenMP)

  • intel
  • foobarbaz

Parallel (MPI)

  • intel
  • openmpi
  • foobarbaz

System Variables

  • HPC_FOOBARBAZ_DIR

Configuration

See the Example_Configuration page for foobarbaz configuration details.

System Variables

  • HPC_FOOBARBAZ_DIR - installation directory

Additional Information

WRITE_ADDITIONAL_INSTRUCTIONS_ON_RUNNING_THE_SOFTWARE_IF_NECESSARY

Usage Policy

WRITE USAGE POLICY HERE (Licensing, Access)

Performance

WRITE_PERFORMANCE_TESTING_RESULTS_HERE

FAQ

  • Q: **A:

Citation

If you publish research that uses foobarbaz you have to cite it as follows: WRITE_CITATION_HERE

Installation

See the Example_Install page for foobarbaz installation notes.