2.2. Execution Procedures

Overview

Matmodlab is executed by running the mml procedure. Several parameters can be set either on the command line or in an environment file (see Environment Settings).

mml Summary

$ mml [-h|help] <command> [<args>]

mml Commands

(empty)

Launch the (empty) Matmodlab gui

build

Build fortran libraries

Optional build arguments
-h, --help    show this help message and exit
-v V          Verbosity
-w            Wipe before building
-W            Wipe and exit
-m M [M ...]  Materials to build
-u            Build auxiliary support files only

clean

Remove files generated by Matmodlab (.pyc, .o, .so, .a, build, etc.)

notebook

Launches an IPython Notebook in the Matmodlab environment. Requires the ipython and ipython-notebook modules.

run

Run a Matmodlab simulation script in the Matmodlab environment.

Required run arguments
source                Python source file
Optional run arguments
-h, --help            show this help message and exit
-v V                  Verbosity
--debug               Debug mode
--sqa                 SQA mode
--switch MATX MATY    Run with MATY instead of MATX, if present(not
                      supported by all models)
-B MATERIAL           Wipe and rebuild MATERIAL before running
-V                    Launch results viewer on completion
-j NPROCS, --nprocs NPROCS
                      Number of simultaneous jobs
-W {std,all,error}    Warning level
-w                    Wipe and rebuild material in Material factory before
                      running

test

mml test is merely a wrapper around py.test

view

Launch the Matmodlab viewer

Required view arguments
sources               Output database file[s]