mira-omf 3.1.0rc1

API Library for Open Mining Format

Version: 3.1.0-rc.1

API library for Open Mining Format, a new standard for mining data backed by the Global Mining Standards & Guidelines Group.

Warning

Pre-Release Notice

This is a Beta release of the Open Mining Format (OMF) and the associated Python API. The storage format and libraries might be changed in backward-incompatible ways and are not subject to any SLA or deprecation policy.

Warning

Alpha-Release Notice

This is a fork created by Mira Geoscience for interoperability with the geoh5 file format.

Why?

An open-source serialization format and API library to support data interchange across the entire mining community.

Scope

This library provides an abstracted object-based interface to the underlying OMF serialization format, which enables rapid development of the interface while allowing for future changes under the hood.

Goals

• The goal of Open Mining Format is to standardize data formats across the mining community and promote collaboration

• The goal of the API library is to provide a well-documented, object-based interface for serializing OMF files

Alternatives

OMF is intended to supplement the many alternative closed-source file formats used in the mining community.

Connections

This library makes use of the properties open-source project, which is designed and publicly supported by Seequent.

Connection to the geoh5 format makes use of geoh5py publicly supported by Mira Geoscience

Installation

To install the repository, ensure that you have pip installed and run:

pip install omf

Or from github:

git clone https://github.com/GMSGDataExchange/omf.git
cd omf
pip install -e .