Skip to content

Latest commit

 

History

History
95 lines (65 loc) · 2.64 KB

README.rst

File metadata and controls

95 lines (65 loc) · 2.64 KB
Raw

omf

Latest PyPI version Documentation MIT license Github actions

Version: 2.0.0a0

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

Warning

Pre-Release Notice

Version 2 of the Open Mining Format (OMF) and the associated Python API is under active development, and subject to backwards-incompatible changes at any time. The latest stable release of Version 1 is available on PyPI.

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.

Installation

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

pip install --pre omf

Or from github:

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

3D Visualization

To easily visualize OMF project files and data objects in a pure Python environment, check out omfvista which provides a module for loading OMF datasets into PyVista mesh objects for 3D visualization and analysis.