semvec/pypi-packages huggingface dataset:
omf 2.0.0a0
API Library for Open Mining Format
License: MIT License
Keywords: mining data interchange

omf
***

.. image:: https://img.shields.io/pypi/v/omf.svg
    :target: https://pypi.org/project/omf/
    :alt: Latest PyPI version

.. image:: https://readthedocs.org/projects/omf/badge/?version=stable
    :target: https://omf.readthedocs.io/en/latest/
    :alt: Documentation

.. image:: https://img.shields.io/badge/license-MIT-blue.svg
    :target: https://github.com/gmggroup/omf/blob/master/LICENSE
    :alt: MIT license

.. image:: https://github.com/gmggroup/omf/actions/workflows/run-tests.yml/badge.svg
    :target: https://github.com/gmggroup/omf/actions
    :alt: Github actions

.. image:: https://codecov.io/gh/gmggroup/omf/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/gmggroup/omf
    :alt: Code coverage


Version: 2.0.0a0

API library for Open Mining Format, a new standard for mining data backed by
the `Global Mining Guidelines Group <https://gmggroup.org>`_.

.. 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 <https://pypi.org/project/omf/1.0.1/>`_.

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 <https://github.com/seequent/properties>`_
open-source project, which is designed and publicly supported by
`Seequent <https://www.seequent.com>`_.

Installation
------------

To install the repository, ensure that you have
`pip installed <https://pip.pypa.io/en/stable/installing/>`_ and run:

.. code::

    pip install omf

Or from `github <https://github.com/gmggroup/omf>`_:

.. code::

    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.

.. _omfvista: https://github.com/OpenGeoVis/omfvista
.. _PyVista: https://github.com/pyvista/pyvista