Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .idea/copyright/GMG.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions .idea/copyright/MiraGeoscience.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

21 changes: 21 additions & 0 deletions .idea/copyright/profiles_settings.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions .idea/scopes/sources.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

24 changes: 22 additions & 2 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,29 @@ repos:
- repo: https://github.com/MiraGeoscience/pre-commit-hooks
rev: v1.0.2
hooks:
# - id: check-copyright # no copyright nor license notice: differ to upstream repo
# files: ^(omf/fileio/geoh5\.py$|omf/scripts/|tests/)
- id: check-copyright
files: (^package\.rst|^LICENSE|^README(|-dev)\.rst|\.py|\.pyi)$
# do not check sources from the original omf package
exclude: |
(?x)(
^\..*|
^docs/.*|
omf/(
fileio/__init__|
fileio/fileio|
fileio/utils|
base|
data|
lineset|
pointset|
serializers|
surface|
texture|
volume)\.py|
tests/doc_example_test\.py
)$
- id: prepare-commit-msg
- id: check-commit-msg
- repo: local
hooks:
- id: pylint
Expand Down
1 change: 1 addition & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
MIT License

Copyright (c) 2017 Global Mining Standards and Guidelines Group
Copyright (c) 2022-2025 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
Expand Down
3 changes: 2 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,8 @@ License
^^^^^^^
MIT License

Copyright (c) 2025 Mira Geoscience
Copyright (c) 2017 Global Mining Standards and Guidelines Group
Copyright (c) 2022-2025 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
Expand Down
21 changes: 19 additions & 2 deletions omf/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
"""omf: API library for Open Mining Format file interchange format"""

# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
# Copyright (c) 2022-2025 Mira Geoscience Ltd. '
# '
# This file is part of mira-omf package. '
# '
# mira-omf is distributed under the terms and conditions of the MIT License '
# (see LICENSE file at the root of this source code package). '
# '
# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
# Copyright (c) 2017 Global Mining Standards and Guidelines Group '
# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

import logging
import sys

Expand Down Expand Up @@ -31,9 +45,12 @@


__version__ = "3.3.0-rc.1"
__author__ = "Global Mining Standards and Guidelines Group"
__author__ = "Global Mining Standards and Guidelines Group, Mira Geoscience Ltd."
__license__ = "MIT License"
__copyright__ = "Copyright 2017 Global Mining Standards and Guidelines Group"
__copyright__ = (
"Copyright 2017 Global Mining Standards and Guidelines Group, "
"Copyright 2022-2025 Mira Geoscience Ltd."
)


def _create_logger():
Expand Down
10 changes: 10 additions & 0 deletions omf/base.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
"""base.py: OMF Project and base classes for its components"""

# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
# Copyright (c) 2017 Global Mining Standards and Guidelines Group '
# '
# This file is part of mira-omf package. '
# '
# mira-omf is distributed under the terms and conditions of the MIT License '
# (see LICENSE file at the root of this source code package). '
# '
# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

from __future__ import annotations

import datetime
Expand Down
10 changes: 10 additions & 0 deletions omf/data.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
"""data.py: different ProjectElementData classes"""

# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
# Copyright (c) 2017 Global Mining Standards and Guidelines Group '
# '
# This file is part of mira-omf package. '
# '
# mira-omf is distributed under the terms and conditions of the MIT License '
# (see LICENSE file at the root of this source code package). '
# '
# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

import numpy as np
import properties

Expand Down
10 changes: 10 additions & 0 deletions omf/fileio/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
# Copyright (c) 2017 Global Mining Standards and Guidelines Group '
# '
# This file is part of mira-omf package. '
# '
# mira-omf is distributed under the terms and conditions of the MIT License '
# (see LICENSE file at the root of this source code package). '
# '
# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

from .fileio import OMFReader, OMFWriter
from .geoh5 import GeoH5Writer
from .utils import compare_elements
10 changes: 10 additions & 0 deletions omf/fileio/fileio.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
"""fileio.py: OMF Writer and Reader for serializing to and from .omf files"""

# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
# Copyright (c) 2017 Global Mining Standards and Guidelines Group '
# '
# This file is part of mira-omf package. '
# '
# mira-omf is distributed under the terms and conditions of the MIT License '
# (see LICENSE file at the root of this source code package). '
# '
# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

from __future__ import annotations

import json
Expand Down
10 changes: 10 additions & 0 deletions omf/fileio/geoh5.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
# Copyright (c) 2022-2025 Mira Geoscience Ltd. '
# '
# This file is part of mira-omf package. '
# '
# mira-omf is distributed under the terms and conditions of the MIT License '
# (see LICENSE file at the root of this source code package). '
# '
# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

# pylint: disable=too-many-lines

from __future__ import annotations
Expand Down
10 changes: 10 additions & 0 deletions omf/fileio/utils.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
# Copyright (c) 2017 Global Mining Standards and Guidelines Group '
# '
# This file is part of mira-omf package. '
# '
# mira-omf is distributed under the terms and conditions of the MIT License '
# (see LICENSE file at the root of this source code package). '
# '
# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

from numpy import testing


Expand Down
10 changes: 10 additions & 0 deletions omf/lineset.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
"""lineset.py: LineSet element and geometry"""

# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
# Copyright (c) 2017 Global Mining Standards and Guidelines Group '
# '
# This file is part of mira-omf package. '
# '
# mira-omf is distributed under the terms and conditions of the MIT License '
# (see LICENSE file at the root of this source code package). '
# '
# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

import numpy as np
import properties

Expand Down
10 changes: 10 additions & 0 deletions omf/pointset.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
"""pointset.py: PointSet element and geometry"""

# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
# Copyright (c) 2017 Global Mining Standards and Guidelines Group '
# '
# This file is part of mira-omf package. '
# '
# mira-omf is distributed under the terms and conditions of the MIT License '
# (see LICENSE file at the root of this source code package). '
# '
# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

import properties

from .base import ProjectElement, ProjectElementGeometry
Expand Down
9 changes: 9 additions & 0 deletions omf/scripts/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
# Copyright (c) 2025 Mira Geoscience Ltd. '
# '
# This file is part of mira-omf package. '
# '
# mira-omf is distributed under the terms and conditions of the MIT License '
# (see LICENSE file at the root of this source code package). '
# '
# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10 changes: 10 additions & 0 deletions omf/scripts/geoh5_to_omf.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
# Copyright (c) 2025 Mira Geoscience Ltd. '
# '
# This file is part of mira-omf package. '
# '
# mira-omf is distributed under the terms and conditions of the MIT License '
# (see LICENSE file at the root of this source code package). '
# '
# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

import argparse
import logging
import sys
Expand Down
10 changes: 10 additions & 0 deletions omf/scripts/omf_to_geoh5.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
# Copyright (c) 2025 Mira Geoscience Ltd. '
# '
# This file is part of mira-omf package. '
# '
# mira-omf is distributed under the terms and conditions of the MIT License '
# (see LICENSE file at the root of this source code package). '
# '
# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

import argparse
import logging
import sys
Expand Down
10 changes: 10 additions & 0 deletions omf/serializers.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
"""serializers.py: array and image serializers/deserializers for OMF file IO"""

# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
# Copyright (c) 2017 Global Mining Standards and Guidelines Group '
# '
# This file is part of mira-omf package. '
# '
# mira-omf is distributed under the terms and conditions of the MIT License '
# (see LICENSE file at the root of this source code package). '
# '
# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

import zlib
from io import BytesIO

Expand Down
10 changes: 10 additions & 0 deletions omf/surface.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
"""surface.py: Surface element and geometry"""

# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
# Copyright (c) 2017 Global Mining Standards and Guidelines Group '
# '
# This file is part of mira-omf package. '
# '
# mira-omf is distributed under the terms and conditions of the MIT License '
# (see LICENSE file at the root of this source code package). '
# '
# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

import numpy as np
import properties

Expand Down
10 changes: 10 additions & 0 deletions omf/texture.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
"""texture.py: contains ImageTexture definition"""

# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
# Copyright (c) 2017 Global Mining Standards and Guidelines Group '
# '
# This file is part of mira-omf package. '
# '
# mira-omf is distributed under the terms and conditions of the MIT License '
# (see LICENSE file at the root of this source code package). '
# '
# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

import properties

from .base import ContentModel
Expand Down
10 changes: 10 additions & 0 deletions omf/volume.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
"""volume.py: Volume element and geometry"""

# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
# Copyright (c) 2017 Global Mining Standards and Guidelines Group '
# '
# This file is part of mira-omf package. '
# '
# mira-omf is distributed under the terms and conditions of the MIT License '
# (see LICENSE file at the root of this source code package). '
# '
# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

import numpy as np
import properties

Expand Down
9 changes: 9 additions & 0 deletions tests/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
# Copyright (c) 2025 Mira Geoscience Ltd. '
# '
# This file is part of mira-omf package. '
# '
# mira-omf is distributed under the terms and conditions of the MIT License '
# (see LICENSE file at the root of this source code package). '
# '
# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
10 changes: 10 additions & 0 deletions tests/conftest.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
# Copyright (c) 2025 Mira Geoscience Ltd. '
# '
# This file is part of mira-omf package. '
# '
# mira-omf is distributed under the terms and conditions of the MIT License '
# (see LICENSE file at the root of this source code package). '
# '
# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

from pathlib import Path

import numpy as np
Expand Down
Loading
Loading