From 7abcaf2cd2cce46cc8573d751ffef65fc1ded33b Mon Sep 17 00:00:00 2001 From: dominiquef Date: Wed, 22 Oct 2025 15:57:00 -0700 Subject: [PATCH 1/2] Add notes --- README.rst | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 415632c..8a5683c 100644 --- a/README.rst +++ b/README.rst @@ -25,7 +25,30 @@ the `Global Mining Standards & Guidelines Group `_. .. warning:: This is a fork created by Mira Geoscience for interoperability with the - geoh5 file format. + geoh5 file format. It is not maintained by GMG. + + The main additions are two scripts for converting between OMF and geoh5: + + - OMF to geoh5 file format: :py:meth:`omf.scripts.omf_to_geoh5 ` + - Geoh5 to OMF: :py:meth:`omf.scripts.geoh5_to_omf ` + + The following objects are supported for conversion between OMF and geoh5: + + - Scatter data:py:class:`omf.pointet.PointSetElement ` to :py:class:`geoh5py.objects.Points ` + - Curve data :py:class:`omf.lineset.LineSetElement ` to :py:class:`geoh5py.objects.Curve ` + - Surface data :py:class:`omf.surface.SurfaceElement ` to :py:class:`geoh5py.objects.Surface ` + - 3D Grid data :py:class:`omf.volume.VolumeElement ` to :py:class:`geoh5py.objects.BlockModel ` + + The following data types are supported for conversion between OMF and geoh5: + + - Float data arrays + - Integer data arrays + - String data arrays + - Referenced data with colormap arrays + + Note that "no-data-value" are not supported by the OMF standard for Integer data arrays. + When converting from geoh5 to OMF, any Integer data arrays containing no-data-values are converted to Float data arrays. + Why? ---- From 379de162b1ce92bf4b2373d486f9d4ccf656c06a Mon Sep 17 00:00:00 2001 From: dominiquef Date: Wed, 22 Oct 2025 16:01:10 -0700 Subject: [PATCH 2/2] Clean up test --- README.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 8a5683c..4d17be8 100644 --- a/README.rst +++ b/README.rst @@ -29,15 +29,15 @@ the `Global Mining Standards & Guidelines Group `_. The main additions are two scripts for converting between OMF and geoh5: - - OMF to geoh5 file format: :py:meth:`omf.scripts.omf_to_geoh5 ` - - Geoh5 to OMF: :py:meth:`omf.scripts.geoh5_to_omf ` + - OMF to geoh5 file format: `omf.scripts.omf_to_geoh5` + - Geoh5 to OMF: `omf.scripts.geoh5_to_omf` The following objects are supported for conversion between OMF and geoh5: - - Scatter data:py:class:`omf.pointet.PointSetElement ` to :py:class:`geoh5py.objects.Points ` - - Curve data :py:class:`omf.lineset.LineSetElement ` to :py:class:`geoh5py.objects.Curve ` - - Surface data :py:class:`omf.surface.SurfaceElement ` to :py:class:`geoh5py.objects.Surface ` - - 3D Grid data :py:class:`omf.volume.VolumeElement ` to :py:class:`geoh5py.objects.BlockModel ` + - Scatter data `omf.pointet.PointSetElement` to `geoh5py.objects.Points` + - Curve data `omf.lineset.LineSetElement` to `geoh5py.objects.Curve` + - Surface data `omf.surface.SurfaceElement` to `geoh5py.objects.Surface` + - 3D Grid data `omf.volume.VolumeElement` to `geoh5py.objects.BlockModel` The following data types are supported for conversion between OMF and geoh5: