Skip to content

Commit 132aab8

Browse files
committed
improved README.md
1 parent 09aafba commit 132aab8

3 files changed

Lines changed: 11 additions & 15 deletions

File tree

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,17 @@
22

33
This package provides a simple interface to read and write OMF files using the [Open Mining Format package (omf)](https://omf.readthedocs.io/en/latest/).
44

5-
The aim of the package is to "Democratise the OMF format" - reducing the barrier to entry for python users to adopt OMF,
6-
by enabling conversion of existing data into and out of OMF files. This could be for tabular block models, raster files, or any other OMF element.
5+
The aim of the package is to **Enable OMF adoption in the Python ecosystem** - reducing the barrier to entry for Python users to adopt OMF.
76

8-
![OMF-IO Animation](https://raw.githubusercontent.com/elphick/omf-io/4-document-supported-formats/docs/_static/omf_io_animation.gif)
7+
OMF-IO enables conversion of existing data into and out of OMF files. This could be for tabular block models, raster files, or any other OMF element.
8+
9+
Use cases include:
10+
11+
- **OMF Creation**: OMF-IO can be used to create OMF files from existing data. This is useful for users who want to create OMF files from scratch or for users who want to convert existing data into OMF format.
12+
- **Export from OMF**: OMF-IO can be used to export OMF files into other formats. This is useful for users who want to share their OMF data with others who may not be using OMF, or for users who want to convert their OMF data into a different format for use in other applications.
13+
- **Adhoc Conversion**: OMF-IO can be used to convert data between different formats. This is useful for users who want to convert their data into a different format for use in other applications, which need not be OMF.
14+
15+
![OMF-IO Animation](https://raw.githubusercontent.com/elphick/omf-io/4-document-supported-formats/docs/source/_static/omf_io_animation.gif)
916

1017
## Installation
1118

docs/source/index.rst

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,6 @@ Welcome to omf-io's documentation!
88

99
This is not a GMG Group managed project, but leverages the great work by all contributors of the OMF project.
1010

11-
.. image:: ./_static/omf_io_animation.gif
12-
:alt: OMF-IO Animation
13-
:align: center
14-
1511
.. include:: ../../README.md
1612
:parser: myst_parser.sphinx_
1713

@@ -32,10 +28,3 @@ Welcome to omf-io's documentation!
3228
license/*
3329

3430

35-
36-
Indices and tables
37-
==================
38-
39-
* :ref:`genindex`
40-
* :ref:`modindex`
41-
* :ref:`search`

docs/source/overview_plot.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ def update(frame):
256256
anim = FuncAnimation(
257257
fig, update, frames=list(animation_dict.keys()), interval=int(1000 / framerate), repeat=False
258258
)
259-
anim.save(output_file, writer='imagemagick')
259+
anim.save(output_file, writer='pillow')
260260

261261

262262
if __name__ == '__main__':

0 commit comments

Comments
 (0)