This API reference is not for the latest stable Salvus version.

`salvus.mesh.layered_meshing.layered_model.bm`

Parse for BM files.

Functions

`bm_to_layered_model()`

def bm_to_layered_model(
    name: Union[pathlib.Path, str], n_dim: int, bm_shift: float = 0.0
) -> Tuple[
    salvus.mesh.layered_meshing.layered_model.layered_model.LayeredModel, float
]:
    ...

Convert a Salvus BM file to a layered model instance.

Parameters

name Union[pathlib.Path, str] — The filename of the BM file, or the name of a builtin model.
n_dim int — The number of dimensions in the model.
bm_shift float — Used to offset layered models in project’s UTM domains to retain previous behavior.

Returns Tuple[salvus.mesh.layered_meshing.layered_model.layered_model.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.