Skip to content
Open mining format specification, documentation and client libraries
Branch: dev
Clone or download
fwkoch Merge pull request #60 from gmggroup/dev
v1.0.1 Deployment - Speed up geometry validation
Latest commit 971bf9c Mar 1, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets
docs Bump version: 1.0.0 → 1.0.1 Mar 1, 2019
omf
tests Merge branch 'dev' into feat/project_preview Dec 19, 2016
.bumpversion.cfg Bump version: 1.0.0 → 1.0.1 Mar 1, 2019
.gitignore Initial commit of readme and other supporting files Nov 29, 2016
.pylintrc Add array attribute to pylint ignore Feb 28, 2019
.pypirc.enc
.travis.yml
LICENSE
MANIFEST.in Initial commit of readme and other supporting files Nov 29, 2016
Makefile
README.rst Merge pull request #60 from gmggroup/dev Mar 1, 2019
requirements.txt
requirements_dev.txt
setup.cfg
setup.py

README.rst

omf

Latest PyPI version Documentation MIT license Travis tests Code coverage

Version: 1.0.1

API library for Open Mining Format, a new standard for mining data backed by the Global Mining 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.

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 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 omfvtk (OMF-VTK) which provides tools for creating interactive renderings of OMF datasets using vtki (the vtkInterface).

You can’t perform that action at this time.