Difference between revisions of "Example"

From UFRC
Jump to navigation Jump to search
m (Malex moved page Test to Example: Have an example of a defined app page look for consistency)
 
(46 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
[[Category:Software]]
 
[[Category:Software]]
 
{|<!--CONFIGURATION: REQUIRED-->
 
{|<!--CONFIGURATION: REQUIRED-->
−
|{{#vardefine:app|test}}
+
|{{#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 22: Line 22:
  
  
−
The software test is a really wonderful tool that lets you tie your shoelaces remotely.
+
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===
 
===Serial===
−
*test
+
*foobarbaz
 
===Parallel (OpenMP)===
 
===Parallel (OpenMP)===
 
*intel
 
*intel
−
*test
+
*foobarbaz
 
===Parallel (MPI) ===
 
===Parallel (MPI) ===
 
*intel
 
*intel
 
*openmpi  
 
*openmpi  
−
*test
+
*foobarbaz
 +
==System Variables==
 +
* HPC_FOOBARBAZ_DIR
 +
<!--Configuration-->
 +
{{#if: {{#var: conf}}|==Configuration==
 +
See the [{{PAGENAME}}_Configuration] page for {{#var: app}} configuration details.
 +
|}}
 +
==System Variables==
 +
* HPC_{{uc:{{#var:app}}}}_DIR - installation directory
 +
<!--Run-->
  
−
<!--Add additional HPC_FOO_BIN and other ENV VARIABLES below-->
 
−
<!--Run-->
 
 
{{#if: {{#var: exe}}|==Additional Information==
 
{{#if: {{#var: exe}}|==Additional Information==
−
DOUBLE_CLICK_TO_WRITE_INSTRUCTIONS_ON_RUNNING_THE_ACTUAL_BINARY
+
WRITE_ADDITIONAL_INSTRUCTIONS_ON_RUNNING_THE_SOFTWARE_IF_NECESSARY
−
|}}
 
−
<!--Configuration-->
 
−
{{#if: {{#var: conf}}|==Configuration==
 
−
See the [[{{PAGENAME}}_Configuration]] page for {{#var: app}} configuration details.
 
 
|}}
 
|}}
 
<!--PBS scripts-->
 
<!--PBS scripts-->
Line 50: Line 53:
 
<!--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, 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-->
Line 62: 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:
−
DOUBLE_CLICK_TO_WRITE_CITATION_HERE
+
WRITE_CITATION_HERE
 
|}}
 
|}}
 
<!--Installation-->
 
<!--Installation-->
 
{{#if: {{#var: installation}}|==Installation==
 
{{#if: {{#var: installation}}|==Installation==
−
See the [[{{PAGENAME}}_Install]] page for {{#var: app}} installation notes.|}}
+
See the [{{PAGENAME}}_Install]] page for {{#var: app}} installation notes.|}}
 
<!--Turn the Table of Contents and Edit paragraph links ON/OFF-->
 
<!--Turn the Table of Contents and Edit paragraph links ON/OFF-->
 
__NOTOC____NOEDITSECTION__
 
__NOTOC____NOEDITSECTION__
 +
Apps that really are listed but show up as orphaned anyways
 +
 +
[[Serving Static Data]]
 +
[[Slurm]]
 +
[[Checkv]]
 +
[[Dram]]
 +
[[Brkraw]]
 +
[[Eddy-squeeze]]
 +
[[Firefox]]
 +
[[Falco]]
 +
[[Hacdivsel]]
 +
[[Harvesttools]]
 +
[[Imagej2]]
 +
[[Kmerfreq]]
 +
[[Magicblast]]
 +
[[Micop]]
 +
[[Moses]]
 +
[[Svtyper]]
 +
[[VARI]]
 +
[[Pvconv]]
 +
[[VirSieve]]
 +
[[Xlsx2csv]]
 +
[[Virsorter]]
 +
[[alfred]]
 +
[[alleleCount]]
 +
[[autodock-vina]]
 +
[[bppSuite]]
 +
[[captus]]
 +
[[deepsig]]
 +
[[garfield]]
 +
[[UMICollapse]]
 +
[[phanotate]]
 +
[[mvrsion]]
 +
[[isonclust2]]
 +
[[srst2]]
 +
[[saige]]
 +
[[maskrc-svg]]
 +
[[circexplorer3]]
 +
[[Alevin-fry]]
 +
[[Asteroid]]
 +
[[Circtools]]
 +
[[Goatools]]
 +
[[Hpsandbox]]
 +
[[Iaps]]
 +
[[Mrtrix3tissue]]
 +
[[Openstructure]]
 +
[[PacMAP]]
 +
[[Stable-diffusion]]
 +
[[Tbprofiler]]
 +
[[ANDI]]
 +
[[Freecad]]
 +
[[Csvpad]]
 +
[[Dancemapper]]
 +
[[Deepfri]]
 +
[[Giggle]]
 +
[[Hylite]]
 +
[[Ngsremix]]
 +
[[Powerfit]]
 +
[[Pymesh]]
 +
[[trimesh]]
 +
[[Xwalk]]
 +
[[Multimatch-gaze]]
 +
[[Vray]]
 +
[[geNomad]]
 +
[[crest]]
 +
[[Rnalysis]]
 +
[[Roguenarok]]
 +
[[Subphaser]]
 +
[[AlphaMate]]
 +
[[Ancestryhmm]]
 +
[[Genewalk]]
 +
[[Genmap]]
 +
[[Faqcs]]
 +
[[magpurify]]
 +
[[pygenometracks]]
 +
 +
 +
Apps haven't shown up yet
 +
 +
Pages that are linked through main categories
 +
[[Database_Hosting]]
 +
[[Consulting]]
 +
[[Mailing_Lists]]
 +
[[Non_Batch-System_Resources]]

Latest revision as of 02:39, 24 May 2023

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.

Apps that really are listed but show up as orphaned anyways

Serving Static Data Slurm Checkv Dram Brkraw Eddy-squeeze Firefox Falco Hacdivsel Harvesttools Imagej2 Kmerfreq Magicblast Micop Moses Svtyper VARI Pvconv VirSieve Xlsx2csv Virsorter alfred alleleCount autodock-vina bppSuite captus deepsig garfield UMICollapse phanotate mvrsion isonclust2 srst2 saige maskrc-svg circexplorer3 Alevin-fry Asteroid Circtools Goatools Hpsandbox Iaps Mrtrix3tissue Openstructure PacMAP Stable-diffusion Tbprofiler ANDI Freecad Csvpad Dancemapper Deepfri Giggle Hylite Ngsremix Powerfit Pymesh trimesh Xwalk Multimatch-gaze Vray geNomad crest Rnalysis Roguenarok Subphaser AlphaMate Ancestryhmm Genewalk Genmap Faqcs magpurify pygenometracks


Apps haven't shown up yet

Pages that are linked through main categories Database_Hosting Consulting Mailing_Lists Non_Batch-System_Resources

Retrieved from "https://help.rc.ufl.edu/mediawiki/index.php?title=Example&oldid=27946"