Skip to main content
Latest PyPI version Documentation MIT license pytest

API library for Open Mining Format, a new standard for mining data backed by the Global Mining Standards & Guidelines Group.

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.

Connection to the geoh5 format makes use of geoh5py publicly supported by Mira Geoscience

Installation

To install the repository, ensure that you have pip installed and run:

pip install omf

Or from github:

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

License

MIT License

Copyright (c) 2017 Global Mining Standards and Guidelines Group Copyright (c) 2022-2026 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.

Metadata

Release files for mira-omf 3.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mira-omf 3.4.0
File Size Uploaded
mira_omf-3.4.0.tar.gz 24.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mira-omf 3.4.0
File Interpreter ABI Platform
mira_omf-3.4.0-py3-none-any.whl Python 3 none any Details

Total release size: 56.3 kB

Release files / mira_omf-3.4.0.tar.gz

Download URL mira_omf-3.4.0.tar.gz
Size 24.8 kB
Tags Source
SHA-256 checksum
How to use checksums
1c873feb0b7e1e661c6071f82ce10a91a78896626506e93a4871367286d2585e
BLAKE2b-256 checksum
How to use checksums
0fb382c4faa54402d04f39d4ec2dea628bd1f494992940d86265e9d2dfdcd905
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.12

Release files / mira_omf-3.4.0-py3-none-any.whl

Download URL mira_omf-3.4.0-py3-none-any.whl
Size 31.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b6e43b053b9916cdfb550403380d86303ec02229f0132811db73b7577b81812a
BLAKE2b-256 checksum
How to use checksums
cb430f37bfc8cf384b69709508d78a5419f7955f14e1a779d34f1477686c92dc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.12
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page