Testing Extensions

Math

In this file format, damage state exceedance probabilities $\mathbb{P}(DS \geq ds_i)$ are named as "$LS_i$", for $i=1,…,5$; similarly, probabilities of being in a damage state $\mathbb{P}(DS = ds_i)$ are named as "$DS_i$", for $i=1,…,5$.

— DesignSafe: User Guide: Use Cases: …

alert boxes

info box

This is an info box and it should be a call out

See example: https://portal.tacc.utexas.edu/user-guides/lonestar6#scratchpurgepolicy

'cmd-line' class examples

login1$ module load kitten

login1$ { .bash }
login1$ module load kitten

login1$ { .bash .cmd-line}
login1$ module load kitten

See example: https://portal.tacc.utexas.edu/user-guides/stampede2#building-basics-mpi

'job-script' class examples

#!/bin/bash
#----------------------------------------------------
# Sample Slurm job script
#   for TACC Stampede2 KNL nodes
#
#   *** Serial Job on Normal Queue ***
#   -- Serial codes run on a single node (upper case N = 1).
#        A serial code ignores the value of lower case n,
#        but slurm needs a plausible value to schedule the job.
#
#   -- For a good way to run multiple serial executables at the
#        same time, execute "module load launcher" followed
#        by "module help launcher".

#----------------------------------------------------

#SBATCH -J myjob           # Job name
#SBATCH -o myjob.o%j       # Name of stdout output file
#SBATCH -e myjob.e%j       # Name of stderr error file
#SBATCH -p normal          # Queue (partition) name
#SBATCH -N 1               # Total # of nodes (must be 1 for serial)
#SBATCH -A myproject       # Allocation name (req'd if you have more than 1)

module load kitten
ibrun -np 4 -N 2 -p small myexecutable

#!/bin/bash
#----------------------------------------------------
# Sample Slurm job script
#   for TACC Stampede2 KNL nodes
#
#   *** Serial Job on Normal Queue ***
#
# Last revised: 20 Oct 2017
#
#----------------------------------------------------

#SBATCH -J myjob           # Job name
#SBATCH -n 1               # Total # of mpi tasks (should be 1 for serial)
#SBATCH -t 01:30:00        # Run time (hh:mm:ss)
#SBATCH --mail-user=username@tacc.utexas.edu
#SBATCH --mail-type=all    # Send email at begin and end of job
#SBATCH -A myproject       # Allocation name (req'd if you have more than 1)

module load randomsoftware
ibrun -N 6 -n 12 myexecutable

Styles I use

details and summary tags

See: https://docs.tacc.utexas.edu/hpcugs/stampede2/stampede2/#jobscripts

I'm not a big fan of this arrow. <br>
Can we add some margin/whitespace at the bottom? <br>
Also, markdown __now works__ within these tags.

Images

I use image tags <figure> and <figcaption>.

See real life example here: https://portal.tacc.utexas.edu/user-guides/stampede2#programming-knl-memorymodes

and demonstrated here

Need more space for long command lines

See old: https://portal.tacc.utexas.edu/user-guides/stampede2#building-performance-architecture

vs.

See new: https://docs.tacc.utexas.edu/hpc/stampede2/#building-performance-architecture

Table renderings are very small

See https://docs.tacc.utexas.edu/hpc/stampede2/#table6

Need a style called "introtext"

Only used in Frontera User Guide.

p class="introtext" - it's just a larger font, used as introductory text.

See https://frontera-portal.tacc.utexas.edu/user-guide/running/. The first sentences, prior to "Job Accounting" should be displayed in a larger than normal font.

Code Examples

See Fiddling: Code Examples.

admonition extension

I use "attention", "note", "warning" the most

attr_list