Mondaic - Full Waveform Solutions

Convert a Salvus BM file to a layered model instance.

SIGNATURE

def bm_to_layered_model(
    name: pathlib.Path | str, n_dim: int | None = None, bm_shift: float = 0.0
) -> tuple[LayeredModel, float]: ...

ARGUMENTS

Required

name

Type:	`pathlib.Path \| str`
Description:	The filename of the BM file, or the name of a builtin model.

Optional

n_dim

Type:	`int \| None`
Default value:	`None`
Description:	The number of dimensions in the model (deprecated).

Optional

bm_shift

Type:	`float`
Default value:	`0.0`
Description:	Used to offset layered models in project's UTM domains to retain previous behavior.

EXCEPTIONS

If the BM file cannot be read.

RETURNS

Return type: tuple[LayeredModel, float]

A layered model representation of the BM file, along with that model's scale parameter and a dictionary of its additional key - value pairs.

salvus.mesh.layered_meshing.layered_model.bm