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.2.1
API library for Open Mining Format, a new standard for mining data backed by
the `Global Mining Standards & Guidelines Group <https://gmggroup.org/>`_.
.. warning::
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 .
License
^^^^^^^
MIT License
Copyright (c) 2024 Mira Geoscience
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Third Party Software
^^^^^^^^^^^^^^^^^^^^
The mira-omf Software may provide links to third party libraries or code (collectively “Third Party Software”)
to implement various functions. Third Party Software does not comprise part of the Software.
The use of Third Party Software is governed by the terms of such software license(s).
Third Party Software notices and/or additional terms and conditions are located in the
`THIRD_PARTY_SOFTWARE.rst`_ file.
.. _THIRD_PARTY_SOFTWARE.rst: THIRD_PARTY_SOFTWARE.rst
Raw data
{
"_id": null,
"home_page": "https://www.mirageoscience.com/mining-industry-software/python-integration/",
"name": "mira-omf",
"maintainer": "Dominique Fournier",
"docs_url": null,
"requires_python": "<3.11,>=3.9",
"maintainer_email": "dominiquef@mirageoscience.com",
"keywords": "geology, geophysics, earth sciences",
"author": "Mira Geoscience",
"author_email": "support@mirageoscience.com",
"download_url": "https://files.pythonhosted.org/packages/f4/95/ae4802a54c8c00c94c97ccf22bb02c7491300458861a97af0e85c3b1f13e/mira_omf-3.2.1.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.2.1\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\n.. warning::\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\nLicense\n^^^^^^^\nMIT License\n\nCopyright (c) 2024 Mira Geoscience\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n\nThird Party Software\n^^^^^^^^^^^^^^^^^^^^\nThe mira-omf Software may provide links to third party libraries or code (collectively \u201cThird Party Software\u201d)\nto implement various functions. Third Party Software does not comprise part of the Software.\nThe use of Third Party Software is governed by the terms of such software license(s).\nThird Party Software notices and/or additional terms and conditions are located in the\n`THIRD_PARTY_SOFTWARE.rst`_ file.\n\n.. _THIRD_PARTY_SOFTWARE.rst: THIRD_PARTY_SOFTWARE.rst\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "API Library for Open Mining Format",
"version": "3.2.1",
"project_urls": {
"Homepage": "https://www.mirageoscience.com/mining-industry-software/python-integration/",
"Repository": "https://github.com/MiraGeoscience/omf"
},
"split_keywords": [
"geology",
" geophysics",
" earth sciences"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "77f78b5bcd1428fe28127c4347ac16bee59f374c9f00a00e3c6da2ed99782fe0",
"md5": "611a7bd31edcaf1995e5654925667258",
"sha256": "c6bbb01ee87f3d98870342e26fbae3cc5b6c474f8080f329f889c602484a2ca8"
},
"downloads": -1,
"filename": "mira_omf-3.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "611a7bd31edcaf1995e5654925667258",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.11,>=3.9",
"size": 30171,
"upload_time": "2024-06-19T19:50:45",
"upload_time_iso_8601": "2024-06-19T19:50:45.531165Z",
"url": "https://files.pythonhosted.org/packages/77/f7/8b5bcd1428fe28127c4347ac16bee59f374c9f00a00e3c6da2ed99782fe0/mira_omf-3.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f495ae4802a54c8c00c94c97ccf22bb02c7491300458861a97af0e85c3b1f13e",
"md5": "c8065cfb6096bf0c0da2bc8a5abd9a4c",
"sha256": "60331b8bd738df561c71402bed1f58e6379c57d427d9f232fe7e92b6d78bc885"
},
"downloads": -1,
"filename": "mira_omf-3.2.1.tar.gz",
"has_sig": false,
"md5_digest": "c8065cfb6096bf0c0da2bc8a5abd9a4c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.11,>=3.9",
"size": 22308,
"upload_time": "2024-06-19T19:50:47",
"upload_time_iso_8601": "2024-06-19T19:50:47.671579Z",
"url": "https://files.pythonhosted.org/packages/f4/95/ae4802a54c8c00c94c97ccf22bb02c7491300458861a97af0e85c3b1f13e/mira_omf-3.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-19 19:50:47",
"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
