Template:HPC-torque-lmp/doc: Difference between revisions

From HPC Wiki
Jump to:navigation Jump to:search
No edit summary
No edit summary
 
Line 7: Line 7:
{{Template Parameter|lang|Language of the contents, used for syntax highlighting|default=text|required=no}}
{{Template Parameter|lang|Language of the contents, used for syntax highlighting|default=text|required=no}}
{{Template Parameter|title|Additional title to display in the box header|required=no}}
{{Template Parameter|title|Additional title to display in the box header|required=no}}
}}
{{Template Parameter|email|Email address to send updates|default=EmailAddress|required=no}}
{{Template Parameter|jobname|Name to job|default=Jobname|required=no}}
{{Template Parameter|inputfile|Name of input file|default=mysimulation|required=no}}}}


== Usage ==
== Usage ==

Latest revision as of 15:40, 9 January 2017

Note
This page is a template. It contains some standardized, often used text, which can be transcluded inside other pages.

As this template is widely used in our wiki, it may be protected in which case only staff members can change it. Use the discussion page to propose enhancements or fixes, or to voice your opinion.

Use this template to specify the path to HPC examples.

Parameters

Parameter name Required? Default value Description
filename No torque-lmp.sh File name
lang No text Language of the contents, used for syntax highlighting
title No (n/a) Additional title to display in the box header
email No EmailAddress Email address to send updates
jobname No Jobname Name to job
inputfile No mysimulation Name of input file

Usage

See the template's testcases:

No parameter
Wiki code {{HPC-torque-lmp}}

Main version
FILE torque-lmp.sh
#PBS -l walltime=10:00:00,mem=15gb,nodes=1:ppn=16
##PBS -M EmailAddress
##PBS -m bae
#PBS -q default
#PBS -N Jobname
#PBS -o myoutput.txt
#PBS -j oe

. $(which lmp-config)

# The LAMMPS input file must have a '.lmp' extension (e.g., mysimulation.lmp).
INPUTFILE=mysimulation

doLAMMPS
Sandbox version Template:HPC-torque-lmp/sandbox
Parameter: lang=bash
Wiki code {{HPC-torque-lmp|lang=bash}}

Main version
FILE torque-lmp.sh
#PBS -l walltime=10:00:00,mem=15gb,nodes=1:ppn=16
##PBS -M EmailAddress
##PBS -m bae
#PBS -q default
#PBS -N Jobname
#PBS -o myoutput.txt
#PBS -j oe

. $(which lmp-config)

# The LAMMPS input file must have a '.lmp' extension (e.g., mysimulation.lmp).
INPUTFILE=mysimulation

doLAMMPS
Sandbox version Template:HPC-torque-lmp/sandbox
Parameters: lang=bash, filename={{HPC-Samples-Dir|flory}}/torque-lmp.sh
Wiki code {{HPC-torque-lmp|lang=bash|filename={{HPC-Samples-Dir|flory}}/torque-lmp.sh}}

Main version
FILE /home/bgo/shared/samples/torque-lmp.sh
#PBS -l walltime=10:00:00,mem=15gb,nodes=1:ppn=16
##PBS -M EmailAddress
##PBS -m bae
#PBS -q default
#PBS -N Jobname
#PBS -o myoutput.txt
#PBS -j oe

. $(which lmp-config)

# The LAMMPS input file must have a '.lmp' extension (e.g., mysimulation.lmp).
INPUTFILE=mysimulation

doLAMMPS
Sandbox version Template:HPC-torque-lmp/sandbox
Parameter: title=Here is the file
Wiki code {{HPC-torque-lmp|title=Here is the file}}

Main version
FILE torque-lmp.shHere is the file
#PBS -l walltime=10:00:00,mem=15gb,nodes=1:ppn=16
##PBS -M EmailAddress
##PBS -m bae
#PBS -q default
#PBS -N Jobname
#PBS -o myoutput.txt
#PBS -j oe

. $(which lmp-config)

# The LAMMPS input file must have a '.lmp' extension (e.g., mysimulation.lmp).
INPUTFILE=mysimulation

doLAMMPS
Sandbox version Template:HPC-torque-lmp/sandbox
Parameters: lang=bash, title=Here is the file
Wiki code {{HPC-torque-lmp|lang=bash|title=Here is the file}}

Main version
FILE torque-lmp.shHere is the file
#PBS -l walltime=10:00:00,mem=15gb,nodes=1:ppn=16
##PBS -M EmailAddress
##PBS -m bae
#PBS -q default
#PBS -N Jobname
#PBS -o myoutput.txt
#PBS -j oe

. $(which lmp-config)

# The LAMMPS input file must have a '.lmp' extension (e.g., mysimulation.lmp).
INPUTFILE=mysimulation

doLAMMPS
Sandbox version Template:HPC-torque-lmp/sandbox
Parameter: inputfile=ellipse.gayberne
Wiki code {{HPC-torque-lmp|inputfile=ellipse.gayberne}}

Main version
FILE torque-lmp.sh
#PBS -l walltime=10:00:00,mem=15gb,nodes=1:ppn=16
##PBS -M EmailAddress
##PBS -m bae
#PBS -q default
#PBS -N Jobname
#PBS -o myoutput.txt
#PBS -j oe

. $(which lmp-config)

# The LAMMPS input file must have a '.lmp' extension (e.g., mysimulation.lmp).
INPUTFILE=ellipse.gayberne

doLAMMPS
Sandbox version Template:HPC-torque-lmp/sandbox
Parameters: email=me@example.com, jobname=ellipse-lmp, inputfile=ellipse.gayberne
Wiki code {{HPC-torque-lmp|email=me@example.com|jobname=ellipse-lmp|inputfile=ellipse.gayberne}}

Main version
FILE torque-lmp.sh
#PBS -l walltime=10:00:00,mem=15gb,nodes=1:ppn=16
#PBS -M me@example.com
#PBS -m bae
#PBS -q default
#PBS -N ellipse-lmp
#PBS -o myoutput.txt
#PBS -j oe

. $(which lmp-config)

# The LAMMPS input file must have a '.lmp' extension (e.g., mysimulation.lmp).
INPUTFILE=ellipse.gayberne

doLAMMPS
Sandbox version Template:HPC-torque-lmp/sandbox