Running sansmic#

There are two commands that can be run from the command line, sansmic and sansmic-convert. The following include all available output options, but note that not all options may be available if you have not installed the appropriate packages (see Advanced Installation).

sansmic#

Simulate leaching in an underground salt cavern due to ordinary solution mining, product withdrawal, or product fill.

usage: sansmic [-h] [--version] [--copyright] [--license] [-o PREFIX]
               [--toml | --no-toml] [--csv | --no-csv] [--hdf | --no-hdf]
               [--json | --no-json] [--tst | --no-tst]
               [--old-out | --no-old-out] [-v | -q | --debug]
               INPUTFILE

Positional Arguments#

INPUTFILE

the SANSMIC input file to use; if extensansmic.ion is ‘.dat’, –toml is implied

Named Arguments#

--version

Display version number and exit.

--copyright

Display full copyright details and exit.

--license

Display full license details and exit.

Default: False

Output options#

Default options: --csv  --tst  --no-hdf  --no-json  --no-old-out

-o, --output

change output file prefix; if used, –toml is implied

--toml

Create a TOML scenario file.

--no-toml

Don’t create a TOML scenario file.

--csv

Create CSV results files.

--no-csv

Don’t create CSV results files.

--hdf

Create an HDF5 formatted results file.

--no-hdf

Don’t create an HDF5 results file.

--json

Create a JSON formatted results file.

--no-json

Don’t create a JSON results file.

--tst

Create a daily summary TST text file.

--no-tst

Don’t create a TST summary file.

--old-out

Create an old-style SANSMIC OUT file.

--no-old-out

Don’t create an old-style OUT file.

Console/stdout/stderr reporting#

The following options are mutually exclusive

-v, --verbose

increase reporting details

Default: 0

-q, --quiet

turn off runtime screen output

Default: False

--debug

turn on debug messages and set max verbosity

Default: False

sansmic-convert#

Convert from an old-style DAT file to the new TOML format.

usage: sansmic-convert [-h] [--version] [--copyright] [--license] [-f]
                       OLD_FILE NEW_FILE

Positional Arguments#

OLD_FILE

the SANSMIC input file to convert

NEW_FILE

the new scenario file to create [extensansmic.ion choices: .toml, .json, .yaml]

Named Arguments#

--version

Display version number and exit.

--copyright

Display full copyright details and exit.

--license

Display full license details and exit.

Default: False

-f, --full

Keep all entries, even if they are blank

Default: False

sansmic (c) 2024 NTESS. Use the –copyright or –license flags for full details.