Commands#

The command-line program, sequence, provides several sub-commands for setting up sequence input files, running sequence, and plotting output (you can use the --help option to get help for the available subcommands). The four subcommands are the following:

  • generate: Generate example input files.

  • setup: Setup a folder of input files for a simulation.

  • run: Run a simulation.

  • plot: Plot a sequence output file.

sequence#

# Sequence.

Sequence is a modular 2D (i.e., profile) sequence stratigraphic model that is written in Python and implemented within the Landlab framework. Sequence represents time-averaged fluvial and marine sediment transport via differential equations. The modular code includes components to deal with sea level changes, sediment compaction, local or flexural isostasy, and tectonic subsidence and uplift.

sequence [OPTIONS] COMMAND1 [ARGS]... [COMMAND2 [ARGS]...]...

Options

--version#

Show the version and exit.

--cd <cd>#

chage to directory, then execute

-s, --silent#

Suppress status status messages, including the progress bar.

-v, --verbose#

Also emit status messages to stderr.

generate#

Generate example input files.

sequence generate [OPTIONS] {bathymetry.csv|sealevel.csv|sequence.toml|sequenc
                  e.yaml|subsidence.csv}

Options

--set <KEY=VALUE>#

Set model parameters

Arguments

INFILE#

Required argument

plot#

Plot a Sequence output file.

sequence plot [OPTIONS] NETCDF_FILE

Options

-S, --set <set>#

Set model parameters

Arguments

NETCDF_FILE#

Required argument

run#

Run a simulation.

## Examples

Create a folder with example input files, `bash $ mkdir sequence-example && cd sequence-example $ sequence setup ` Run a simulation using the examples input files, `bash $ sequence run `

sequence run [OPTIONS]

Options

--dry-run#

do not actually run the model

--with-citations#

print citations for components used

setup#

Create a folder of input files for a simulation.

sequence setup [OPTIONS]

Options

--set <set>#

Set model parameters