GitHub source

evo.blockmodels.typed.regular_block_model.RegularBlockModelData

Data class for creating a new regular block model.

Parameters:

Name Type Description Default
name str

The name of the block model.

required
origin Point3

The origin point of the block model grid.

required
n_blocks Size3i

The number of blocks in each dimension (nx, ny, nz).

required
block_size Size3d

The size of each block in each dimension (dx, dy, dz).

required
rotations list[tuple[RotationAxis, float]]

List of rotations as (axis, angle) tuples. Angle is in degrees, positive angles indicate clockwise rotation when looking down the axis.

list()
cell_data DataFrame | None

Optional DataFrame containing block attribute data. Must include geometry columns (i, j, k) or (x, y, z) and attribute columns.

None
description str | None

Optional description of the block model.

None
coordinate_reference_system str | None

Optional coordinate reference system (e.g., "EPSG:4326").

None
size_unit_id str | None

Optional unit identifier for block sizes (e.g., "m").

None
units dict[str, str]

Optional dictionary mapping column names to unit identifiers.

dict()