`salvus.mesh.layered_meshing.layered_model.bm`

Parse for BM files.

Functions

`bm_to_layered_model()`

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

Convert a Salvus BM file to a layered model instance.

Parameters

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

Returns 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.