Skip to content

containers and I/O

name summary used in
Table Columnar attribute table; exchanges data with pyarrow, polars and pandas through the Arrow PyCapsule interface. 5
PointSet Scattered samples: coordinates plus an attribute table. 8
BlockModel Regular or masked grid of blocks, 2D or 3D, optionally rotated. 78
BlockModelFile A block model file read in chunks, for models larger than memory. 1
Mesh Triangulated surface or solid with per-vertex and per-face attributes. 2
MeshReport Problems found by Mesh.validate.
Polylines Lines and polygons with one attribute row per feature. 4
convex_hull Convex hull of (n, 3) points as a closed mesh.
grid_surface Triangulated surface from a gridded elevation, such as topography. 4
read_csv Reads a headed CSV; numbers become float64, nodata values become null. 2
write_csv Writes a headed CSV. 3
read_gslib Reads a GSLIB file; the title is kept in the schema metadata and nodata values, as in read_csv, become null.
write_gslib Writes numeric columns as GSLIB; nulls are written as nodata.
read_parquet Reads Parquet as the PointSet, BlockModel or Polylines it was written from, or a Table. 3
write_parquet Writes a PointSet, a BlockModel, Polylines or any table to Parquet; containers keep their geometry, layout and CRS in the file metadata. 4
read_mesh Reads a .obj, .stl or .dxf mesh. 1
write_mesh Writes a .obj, .stl or ASCII R2000 .dxf mesh. 1
read_segy Reads a post-stack SEG-Y cube as a 3D BlockModel. 1
write_segy Writes one column of a BlockModel as SEG-Y revision 1. 1
read_shapefile Reads a shapefile as a PointSet or Polylines. 1
write_shapefile Writes a PointSet or Polylines as a 3D shapefile. 1
read_geopackage Reads a GeoPackage feature layer as a PointSet or Polylines. 1
write_geopackage Writes a PointSet or Polylines as a GeoPackage feature layer. 1
read_geotiff Reads a GeoTIFF raster as a 2D BlockModel. 1
write_geotiff Writes a 2D BlockModel as a deflate-compressed GeoTIFF. 1
set_units Sets project-wide units: readers and constructors give column name the unit columns[name] when it has none, and coordinates the unit length when they have none.
units Project units for a with block, restored on exit. 1