landlab.framework.interfaces

The Basic Modeling Interface.

exception BadVarNameError

Bases: Error

Exception to indicate a bad input/output variable name.

__init__(name)

__new__(**kwargs)

add_note()

Exception.add_note(note) – add a note to the exception

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

class BmiBase

Bases: object

Definition of the Basic Modeling Interface.

__init__()

__new__(**kwargs)

finalize()

Clean-up model.

get_current_time()

Current time of model.

get_end_time()

Model stop time.

get_input_var_names()

Get names of input variables to the model as standard names.

Returns:

A list of input standard names as strings

get_output_var_names()

Get names of output variables to the model as standard names.

Returns:

A list of output standard names as strings

get_start_time()

Model start time.

get_time_step()

Model time step.

get_var_rank(var_name)

Rank of exchange item.

get_var_type(var_name)

Get type of an exchange item.

get_var_units(var_name)

Get units of an exchange item.

initialize(file_name)

Initialize model.

File_name:

String of configuration file

update(**kwds)

Update model by one time step.

class BmiExtendedBase

Bases: object

An extension interface for a BMI.

__init__()

__new__(**kwargs)

run_model()

Initialize, run, and finalize a model.

update_until(time)

Update model until some time.

Time:

Update duration

class BmiGridType

Bases: int

Base type to indicate the type of a BMI model’s grid.

Code:

Grid type code as an int

Name:

Name of the grid type as a string

static __new__(cls, code, name)

class BmiNoGrid

Bases: object

BMI for a model that does not have a grid.

__init__()

__new__(**kwargs)

class BmiRectilinear

Bases: object

BMI for a model that uses a rectilinear grid.

__init__()

__new__(**kwargs)

get_columns(name)

Get coordinates of grid columns.

get_grid_shape(name)

Get shape of grid for variable, name.

Name:

Standard name

get_rows(name)

Get coordinates of grid rows.

class BmiStructured

Bases: object

BMI for a model that uses a structured grid.

__init__()

__new__(**kwargs)

get_grid_shape(name)

Get shape of grid for variable, name.

Name:

Standard name

get_x(name)

Get x-coordinates of grid nodes.

get_y(name)

Get y-coordinates of grid nodes.

class BmiUniformRectilinear

Bases: object

BMI for a model that exposes a uniform rectilinear grid.

__init__()

__new__(**kwargs)

get_grid_origin(name)

Get origin of grid for variable, name.

Name:

Standard name

get_grid_shape(name)

Get shape of grid for variable, name.

Name:

Standard name

get_grid_spacing(name)

Get spacing of grid for variable, name.

Name:

Standard name

class BmiUnstructured

Bases: object

BMI for a model that uses an unstructured grid.

__init__()

__new__(**kwargs)

get_connectivity(name)

Get cell connectivity.

get_offset(name)

Get cell offset.

get_x(name)

Get x-coordinates of grid nodes.

get_y(name)

Get y-coordinates of grid nodes.

exception Error

Bases: Exception

Base class for BMI exceptions.

__init__(*args, **kwargs)

__new__(**kwargs)

add_note()

Exception.add_note(note) – add a note to the exception

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception FatalError

Bases: Exception

Raise this exception if an unrecoverable error was found.

__init__(*args, **kwargs)

__new__(**kwargs)

add_note()

Exception.add_note(note) – add a note to the exception

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception MissingModelAttributeError

Bases: Error

Raise this exception if a component is missing a required attribute.

__init__(attrib)

__new__(**kwargs)

add_note()

Exception.add_note(note) – add a note to the exception

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception TimeBoundsError

Bases: Error

Raise this exception if a component updates beyond its time horizon.

__init__(*args, **kwargs)

__new__(**kwargs)

add_note()

Exception.add_note(note) – add a note to the exception

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.