View source for User:Bgo/sandbox Update Examples

Get a copy of the current examples for submitting jobs and compiling programs.
{{WIP|author=bgo}}
__TOC__
= Update Examples Script =

As new software is installed, and system updates occur, the examples for submitting jobs and compiling programs are changed and improved. To make it easy to get a copy of the latest examples, the {{C|update-examples}} script is used.

== Script Options ==

{{Command Option Table|1=
{{Command Option|short=d|type=string|Directory to save current examples. The examples will be saved to a subdirectory of the directory specified here. (Default: $HOME/examples)|required=yno}}
{{Command Option|short=h||Help|required=no}} }}

The {{C|update-examples}} script will accept a few options, shown in the table above.

= Using the Script =

The most common way to use {{C|update-examples}} is to simply run the script with no options, like:

{{Cmd|update-examples|output=<pre>Examples for submitting jobs on Magnolia Cluster
================================================

1) lammps - LAMMPS

2) qe - Quantum ESPRESSO

3) MPI - Compiling MPI programs

4) CUDA - Compiling CUDA programs

5) Molpro - Molpro Quantum Chemistry

See the README.txt file inside each directory for instructions on
how to run the examples (e.g., cat README.txt).

New examples saved to /home/user/examples/20171023-153349.</pre>}}

The script will show a short message about the current examples. By default, the new examples will be saved in a directory with a date-time format of YYYYMMDD-HHMMSS. The location of the new examples is shown in the last line of the output. To see the contents of the new directory, use the {{C|ls}} command:

{{Cmd|ls /home/user/examples/20171023-153349|output=<pre>CUDA  lammps  Molpro  MPI  qe  README.txt</pre>}}