https://github.com/elphick/omfpandas

A pandas interface for the Open Mining Format package (omf).
https://github.com/elphick/omfpandas

omf pandas

Last synced: about 2 months ago
JSON representation

A pandas interface for the Open Mining Format package (omf).

• Host: GitHub
• URL: https://github.com/elphick/omfpandas
• Owner: elphick
• License: mit
• Created: 2024-06-17T23:30:24.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2026-02-04T09:48:34.000Z (4 months ago)
• Last Synced: 2026-02-16T18:32:30.377Z (4 months ago)
• Topics: omf, pandas
• Language: Python
• Homepage: https://elphick.github.io/omfpandas/
• Size: 23.2 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
# omfpandas

[![PyPI](https://img.shields.io/pypi/v/omfpandas.svg?logo=python&logoColor=white)](https://pypi.org/project/omfpandas/)

[![Run Tests](https://github.com/Elphick/omfpandas/actions/workflows/poetry_build_and_test.yml/badge.svg?branch=main)](https://github.com/Elphick/omfpandas/actions/workflows/poetry_build_and_test.yml)

[![Publish Docs](https://github.com/Elphick/omfpandas/actions/workflows/poetry_sphinx_docs_to_gh_pages.yml/badge.svg?branch=main)](https://github.com/Elphick/omfpandas/actions/workflows/poetry_sphinx_docs_to_gh_pages.yml)

A pandas (and parquet) interface for the [Open Mining Format package (omf)](https://omf.readthedocs.io/en/latest/).

When working with OMF files, it is often useful to convert the data to a pandas DataFrame.

This package provides a simple interface to do so.

The parquet format is a nice, compact, efficient format to persist pandas DataFrames.

This package also provides a simple interface to convert an omf element to a parquet file.

When datasets do not fit into memory, parquet files can be read in chunks or by column.

> **Note:**

> This package *only* supports omf 2.0, which is currently only a pre-release.

## Installation

```bash

pip install omfpandas

```

If you intend to use the parquet functionality, you will need to install the optional dependencies.

```bash

pip install omfpandas[io]

```

## Roadmap

- [x] 0.2.0 - Add support for reading a VolumeElement (Block Model) from an OMF file as a pandas DataFrame. 

  Export a VolumeElement as a parquet file.

- [x] 0.3.0 - Add support for writing a DataFrame to an OMF BlockModel.  Version 2.0 of the OMF spec is supported.

- [x] 0.4.0 - Convert to omf 2.0 support.

- [x] 0.5.0 - Block model profiling, with reports persisted in the omf file.

- [x] 0.6.0 - Optional block model validation using pandera json schemas.

- [x] ...

- [ ] 0.9.0 - Add support for low-memory/out-of-core writing an omf element to parquet

- [ ] ...