Metadata-Version: 2.1
Name: mira-omf
Version: 3.0.0a3
Summary: API Library for Open Mining Format
Home-page: http://www.globalminingstandards.org/
Keywords: geology,geophysics,earth sciences
Author: Mira Geoscience
Author-email: dominiquef@mirageoscience.com
Requires-Python: >=3.7.2,<3.11
Classifier: Development Status :: 4 - Beta
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Dist: geoh5py (==0.5.0)
Requires-Dist: numpy (>=1.7,<2.0)
Requires-Dist: properties (>=0.4.0,<0.5.0)
Requires-Dist: pypng (>=0.20220715,<0.20220716)
Requires-Dist: six (>=1.16,<2.0)
Requires-Dist: vectormath (>=0.2.0,<0.3.0)
Project-URL: Repository, https://github.com/MiraGeoscience/omf
Description-Content-Type: text/x-rst

omf
***

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

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

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

.. image:: https://github.com/MiraGeoscience/omf/actions/workflows/pytest-windows.yml/badge.svg
    :target: https://github.com/MiraGeoscience/omf/actions/workflows/pytest-windows.yml
    :alt: pytest


Version: 0.9.3

API library for Open Mining Format, a new standard for mining data backed by
the `Global Mining Standards & Guidelines Group <http://www.globalminingstandards.org/>`_.

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

Connection to the geoh5 format makes use of `geoh5py <https://geoh5py.readthedocs.io/>`_
publicly supported by `Mira Geoscience <https://mirageoscience.com/>`_

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

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

.. code:: bash

    pip install omf

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

.. code:: bash

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

