Difference between revisions of "Structure"

From UFRC
Jump to navigation Jump to search
m (Text replace - "==Available versions== (.*)+ <!-- -->" to "<!--Modules-->")
 
(14 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
__NOEDITSECTION__
 
__NOEDITSECTION__
[[Category:Software]][[Category:Bioinformatics]]
+
[[Category:Software]][[Category:Biology]][[Category:Genomics]]
<!-- ########  Template Configuration ######## -->
+
{|<!--Main settings - REQUIRED-->
<!--Edit definitions of the variables used in template calls
 
Required variables:
 
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|structure}}
 
|{{#vardefine:app|structure}}
 
|{{#vardefine:url|http://pritch.bsd.uchicago.edu/structure_software/release_versions/v2.3.3/html/structure.html}}
 
|{{#vardefine:url|http://pritch.bsd.uchicago.edu/structure_software/release_versions/v2.3.3/html/structure.html}}
<!--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:exe|}} <!--Present manual instructions for running the software -->
 
|{{#vardefine:conf|}} <!--Enable config wiki page link - {{#vardefine:conf|1}} = ON/conf|}} = OFF-->
 
|{{#vardefine:conf|}} <!--Enable config wiki page link - {{#vardefine:conf|1}} = ON/conf|}} = OFF-->
Line 38: Line 23:
  
 
You will have to provide the mainparams and extraparams files in a working
 
You will have to provide the mainparams and extraparams files in a working
directory from which you run the software. Sample files are located in
+
directory from which you run the software or via the arguments:
''$HPC_STRUCTURE_CONF'' directory.
+
* -m /path/to/mainparams
 +
* -e /path/to/extraparams
 +
* -s /path/to/STRATparams
  
 +
Sample files are located in the''$HPC_STRUCTURE_CONF'' directory.
 
<!--Modules-->
 
<!--Modules-->
{{#if: {{#var: mod}}|==Execution Environment and Modules==
+
==Environment Modules==
{{App_Module|app={{#var:app}}|intel={{#var:intel}}|mpi={{#var:mpi}}}}|}}
+
Run <code>module spider {{#var:app}}</code> to find out what environment modules are available for this application.
 +
==System Variables==
 +
* HPC_{{uc:{{#var:app}}}}_DIR - installation directory
 
* HPC_STRUCTURE_BIN - executable directory
 
* HPC_STRUCTURE_BIN - executable directory
 
* HPC_STRUCTURE_DOC - documentation directory
 
* HPC_STRUCTURE_DOC - documentation directory
Line 53: Line 43:
 
{{#if: {{#var: pbs}}|==PBS Script Examples==
 
{{#if: {{#var: pbs}}|==PBS Script Examples==
 
See the [[{{PAGENAME}}_PBS]] page for {{#var: app}} PBS script examples.|}}
 
See the [[{{PAGENAME}}_PBS]] page for {{#var: app}} PBS script examples.|}}
{{#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 (perhaps templates for a couple of main licensing schemes can be used)|}}
 
{{#if: {{#var: testing}}|==Performance==
 
{{#if: {{#var: testing}}|==Performance==

Latest revision as of 16:03, 22 August 2022

Description

structure website  

Structure implements a model-based clustering method for inferring population structure using genotype data consisting of unlinked markers

You will have to provide the mainparams and extraparams files in a working directory from which you run the software or via the arguments:

  • -m /path/to/mainparams
  • -e /path/to/extraparams
  • -s /path/to/STRATparams

Sample files are located in the$HPC_STRUCTURE_CONF directory.

Environment Modules

Run module spider structure to find out what environment modules are available for this application.

System Variables

  • HPC_STRUCTURE_DIR - installation directory
  • HPC_STRUCTURE_BIN - executable directory
  • HPC_STRUCTURE_DOC - documentation directory
  • HPC_STRUCTURE_CONF - directory with sample configuration files