omf
***
.. image:: https://img.shields.io/pypi/v/mira-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/main/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: 3.1.0
API library for Open Mining Format, a new standard for mining data backed by
the `Global Mining Standards & Guidelines Group <https://gmggroup.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 .
Raw data
{
"_id": null,
"home_page": "http://www.globalminingstandards.org/",
"name": "mira-omf",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<3.11",
"maintainer_email": "",
"keywords": "geology,geophysics,earth sciences",
"author": "Mira Geoscience",
"author_email": "dominiquef@mirageoscience.com",
"download_url": "https://files.pythonhosted.org/packages/62/15/304bec4da63077e834a750b6de45f0279c3f2efa0057f75650701677c926/mira_omf-3.1.0.tar.gz",
"platform": null,
"description": "omf\n***\n\n.. image:: https://img.shields.io/pypi/v/mira-omf.svg\n :target: https://pypi.python.org/pypi/mira-omf\n :alt: Latest PyPI version\n\n.. image:: https://readthedocs.org/projects/omf/badge/?version=stable\n :target: http://omf.readthedocs.io/en/stable/\n :alt: Documentation\n\n.. image:: https://img.shields.io/badge/license-MIT-blue.svg\n :target: https://github.com/MiraGeoscience/omf/blob/main/LICENSE\n :alt: MIT license\n\n.. image:: https://github.com/MiraGeoscience/omf/actions/workflows/pytest-windows.yml/badge.svg\n :target: https://github.com/MiraGeoscience/omf/actions/workflows/pytest-windows.yml\n :alt: pytest\n\n\nVersion: 3.1.0\n\nAPI library for Open Mining Format, a new standard for mining data backed by\nthe `Global Mining Standards & Guidelines Group <https://gmggroup.org/>`_.\n\n.. warning::\n **Pre-Release Notice**\n\n This is a Beta release of the Open Mining Format (OMF) and the associated\n Python API. The storage format and libraries might be changed in\n backward-incompatible ways and are not subject to any SLA or deprecation\n policy.\n\n.. warning::\n **Alpha-Release Notice**\n\n This is a fork created by Mira Geoscience for interoperability with the\n geoh5 file format.\n\nWhy?\n----\n\nAn open-source serialization format and API library to support data interchange\nacross the entire mining community.\n\nScope\n-----\n\nThis library provides an abstracted object-based interface to the underlying\nOMF serialization format, which enables rapid development of the interface while\nallowing for future changes under the hood.\n\nGoals\n-----\n\n- The goal of Open Mining Format is to standardize data formats across the\n mining community and promote collaboration\n- The goal of the API library is to provide a well-documented, object-based\n interface for serializing OMF files\n\nAlternatives\n------------\n\nOMF is intended to supplement the many alternative closed-source file formats\nused in the mining community.\n\nConnections\n-----------\n\nThis library makes use of the `properties <https://github.com/seequent/properties>`_\nopen-source project, which is designed and publicly supported by\n`Seequent <https://seequent.com>`_.\n\nConnection to the geoh5 format makes use of `geoh5py <https://geoh5py.readthedocs.io/>`_\npublicly supported by `Mira Geoscience <https://mirageoscience.com/>`_\n\nInstallation\n------------\n\nTo install the repository, ensure that you have\n`pip installed <https://pip.pypa.io/en/stable/installing/>`_ and run:\n\n.. code:: bash\n\n pip install omf\n\nOr from `github <https://github.com/GMSGDataExchange/omf>`_:\n\n.. code:: bash\n\n git clone https://github.com/GMSGDataExchange/omf.git\n cd omf\n pip install -e .\n\n",
"bugtrack_url": null,
"license": "",
"summary": "API Library for Open Mining Format",
"version": "3.1.0",
"project_urls": {
"Homepage": "http://www.globalminingstandards.org/",
"Repository": "https://github.com/MiraGeoscience/omf"
},
"split_keywords": [
"geology",
"geophysics",
"earth sciences"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d0fa30e20459a49eaf91a6a23b2f72a50bef450ab11e4f1e575caa936742e6fd",
"md5": "e74f3ae54bd0760cfb3e43588900e98d",
"sha256": "626e159fa0d870360acd25ae298b775ece8140018ba1671925150809dead378f"
},
"downloads": -1,
"filename": "mira_omf-3.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e74f3ae54bd0760cfb3e43588900e98d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<3.11",
"size": 26006,
"upload_time": "2024-01-10T23:50:59",
"upload_time_iso_8601": "2024-01-10T23:50:59.584059Z",
"url": "https://files.pythonhosted.org/packages/d0/fa/30e20459a49eaf91a6a23b2f72a50bef450ab11e4f1e575caa936742e6fd/mira_omf-3.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6215304bec4da63077e834a750b6de45f0279c3f2efa0057f75650701677c926",
"md5": "e0943c71116fad3eed58a6bb777c7be6",
"sha256": "f6b6bad58d7086b0822b5e718b3441176ac3bcc8df6f16b845bbdda04d752e84"
},
"downloads": -1,
"filename": "mira_omf-3.1.0.tar.gz",
"has_sig": false,
"md5_digest": "e0943c71116fad3eed58a6bb777c7be6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<3.11",
"size": 20727,
"upload_time": "2024-01-10T23:51:01",
"upload_time_iso_8601": "2024-01-10T23:51:01.406593Z",
"url": "https://files.pythonhosted.org/packages/62/15/304bec4da63077e834a750b6de45f0279c3f2efa0057f75650701677c926/mira_omf-3.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-10 23:51:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MiraGeoscience",
"github_project": "omf",
"travis_ci": true,
"coveralls": true,
"github_actions": true,
"lcname": "mira-omf"
}
JSON
