omfpandas.converter.OMFDataConverter

class omfpandas.converter.OMFDataConverter(filepath)

A class to handle conversions between OMF and other formats.

__init__(filepath)

Instantiate the OMFConverter object

Parameters:

filepath (Path) – Path to the OMF file.

Methods

__init__(filepath)	Instantiate the OMFConverter object
blockmodel_to_parquet(blockmodel_name, ...)	Write a VolumeElement to a Parquet file.
get_element_attribute_names(element_name)	Get the attribute names of an element.
get_element_by_name(element_name)	Get an element by its name.
view_block_model_profile(blockmodel_name[, ...])	View the profile of a BlockModel in the default web browser.

Attributes

changelog

Return the change log as a DataFrame.

blockmodel_to_parquet(blockmodel_name, parquet_filepath, allow_overwrite=False)

Write a VolumeElement to a Parquet file.

Parameters:

• blockmodel_name (str) – The name of the VolumeElement to convert.

• parquet_filepath (Path) – The path to the Parquet file to write.

• allow_overwrite (bool) – If True, overwrite the existing Parquet file. Default is False.

Raises:

ValueError – If the element retrieved is not a VolumeElement.