Difference between revisions of "Example"
Jump to navigation
Jump to search
Moskalenko (talk | contribs) m (Text replacement - "#uppercase" to "uc") |
|||
| (13 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
[[Category:Software]] | [[Category:Software]] | ||
{|<!--CONFIGURATION: REQUIRED--> | {|<!--CONFIGURATION: REQUIRED--> | ||
| − | |{{#vardefine:app| | + | |{{#vardefine:app|foobarbaz}} |
| − | |{{#vardefine:url|http://wiki. | + | |{{#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--> | ||
|{{#vardefine:intel|}} <!-- "11.1" - Compiler Module Choice --> | |{{#vardefine:intel|}} <!-- "11.1" - Compiler Module Choice --> | ||
|{{#vardefine:mpi|}} <!-- "openmpi/1.3.4"- MPI Module Choice --> | |{{#vardefine:mpi|}} <!-- "openmpi/1.3.4"- MPI Module Choice --> | ||
| − | |{{#vardefine:exe|}} <!--RUNNING --> | + | |{{#vardefine:exe|1}} <!--RUNNING --> |
| − | |{{#vardefine:conf|}} <!--CONFIGS--> | + | |{{#vardefine:conf|1}} <!--CONFIGS--> |
|{{#vardefine:pbs|}} <!--PBS SCRIPTS--> | |{{#vardefine:pbs|}} <!--PBS SCRIPTS--> | ||
| − | |{{#vardefine:policy|}} <!--POLICY--> | + | |{{#vardefine:policy|1}} <!--POLICY--> |
| − | |{{#vardefine:testing|}} <!--TESTING/PROFILING--> | + | |{{#vardefine:testing|1}} <!--TESTING/PROFILING--> |
| − | |{{#vardefine:faq|}} <!--FAQ--> | + | |{{#vardefine:faq|1}} <!--FAQ--> |
| − | |{{#vardefine:citation|}} <!--CITATION--> | + | |{{#vardefine:citation|1}} <!--CITATION--> |
| − | |{{#vardefine:installation|}} <!--INSTALLATION--> | + | |{{#vardefine:installation|1}} <!--INSTALLATION--> |
|} | |} | ||
<!--BODY--> | <!--BODY--> | ||
| Line 22: | Line 22: | ||
| − | The software | + | The software foobarbaz is a really wonderful tool that lets you tie your shoelaces remotely. |
<!--Modules--> | <!--Modules--> | ||
==Required Modules== | ==Required Modules== | ||
[[Modules|modules documentation]] | [[Modules|modules documentation]] | ||
| − | + | ===Serial=== | |
| − | + | *foobarbaz | |
| − | intel | + | ===Parallel (OpenMP)=== |
| − | + | *intel | |
| − | + | *foobarbaz | |
| − | + | ===Parallel (MPI) === | |
| − | + | *intel | |
| − | + | *openmpi | |
| − | + | *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--> | ||
| + | |||
| + | {{#if: {{#var: exe}}|==Additional Information== | ||
| + | WRITE_ADDITIONAL_INSTRUCTIONS_ON_RUNNING_THE_SOFTWARE_IF_NECESSARY | ||
|}} | |}} | ||
<!--PBS scripts--> | <!--PBS scripts--> | ||
| Line 44: | Line 52: | ||
See the [[{{PAGENAME}}_PBS]] page for {{#var: app}} PBS script examples.|}} | See the [[{{PAGENAME}}_PBS]] page for {{#var: app}} PBS script examples.|}} | ||
<!--Policy--> | <!--Policy--> | ||
| − | {{#if: {{#var: policy}}|==Usage | + | {{#if: {{#var: policy}}|==Usage Policy== |
| − | WRITE USAGE POLICY HERE ( | + | WRITE USAGE POLICY HERE (Licensing, Access) |
|}} | |}} | ||
<!--Performance--> | <!--Performance--> | ||
{{#if: {{#var: testing}}|==Performance== | {{#if: {{#var: testing}}|==Performance== | ||
| − | + | WRITE_PERFORMANCE_TESTING_RESULTS_HERE | |
|}} | |}} | ||
<!--Faq--> | <!--Faq--> | ||
| Line 57: | Line 65: | ||
{{#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 | |
|}} | |}} | ||
<!--Installation--> | <!--Installation--> | ||
Revision as of 21:20, 6 December 2019
Description
The software foobarbaz is a really wonderful tool that lets you tie your shoelaces remotely.
Required Modules
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.