xtgeo 4.10.1__cp313-cp313-macosx_11_0_arm64.whl → 4.14.0__cp313-cp313-macosx_11_0_arm64.whl

xtgeo/metadata/metadata.py

@@ -10,10 +10,23 @@ The metadata works through the various datatypes in XTGeo. For example::
 
 """
 
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
 import xtgeo
 from xtgeo.common.constants import UNDEF
 from xtgeo.common.log import null_logger
 
+if TYPE_CHECKING:
+    from datetime import datetime
+
+    from xtgeo.cube.cube1 import Cube
+    from xtgeo.grid3d.grid import Grid, GridProperty
+    from xtgeo.surface.regular_surface import RegularSurface
+    from xtgeo.well.well1 import Well
+
+
 logger = null_logger(__name__)
 
 
@@ -49,11 +62,11 @@ class _OptionalMetaData:
     def __init__(self) -> None:
         self._name = "A Longer Descriptive Name e.g. from SMDA"
         self._shortname = "TheShortName"
-        self._datatype = None
-        self._md5sum = None
+        self._datatype: str | None = None
+        self._md5sum: str | None = None
         self._description = "Some description"
         self._crs = None
-        self._datetime = None
+        self._datetime: datetime | str | None = None
         self._deltadatetime = None
         self._visuals = {"colortable": "rainbow", "lower": None, "upper": None}
         self._domain = "depth"
@@ -68,29 +81,29 @@ class _OptionalMetaData:
         self._source = "unknown"
 
     @property
-    def name(self):
+    def name(self) -> str:
         return self._name
 
     @name.setter
-    def name(self, newname):
+    def name(self, newname: str) -> None:
         # TODO: validation
         self._name = newname
 
     @property
-    def datetime(self):
+    def datetime(self) -> datetime | str | None:
         return self._datetime
 
     @datetime.setter
-    def datetime(self, newdate):
+    def datetime(self, newdate: datetime | str) -> None:
         # TODO: validation
         self._datetime = newdate
 
     @property
-    def shortname(self):
+    def shortname(self) -> str:
         return self._shortname
 
     @shortname.setter
-    def shortname(self, newname):
+    def shortname(self, newname: str) -> None:
         if not isinstance(newname, str):
             raise ValueError("The shortname must be a string.")
         if len(newname) >= 32:
@@ -99,11 +112,11 @@ class _OptionalMetaData:
         self._shortname = newname
 
     @property
-    def description(self):
+    def description(self) -> str:
         return self._description
 
     @description.setter
-    def description(self, newstr):
+    def description(self, newstr: str) -> None:
         if not isinstance(newstr, str):
             raise ValueError("The description must be a string.")
         if len(newstr) >= 64:
@@ -115,7 +128,7 @@ class _OptionalMetaData:
         self._description = newstr
 
     @property
-    def md5sum(self):
+    def md5sum(self) -> str | None:
         """Set or get the md5 checksum of file content.
 
         See generate_hash() method in e.g. RegularSurface.
@@ -123,11 +136,11 @@ class _OptionalMetaData:
         return self._md5sum
 
     @md5sum.setter
-    def md5sum(self, newhash):
+    def md5sum(self, newhash: str) -> None:
         # TODO: validation
         self._md5sum = newhash
 
-    def get_meta(self):
+    def get_meta(self) -> dict[str, Any]:
         """Return metadata as an dict."""
         meta = {}
         for key in self.__slots__:
@@ -140,15 +153,15 @@ class _OptionalMetaData:
 class MetaData:
     """Generic metadata class, not intended to be used directly."""
 
-    def __init__(self):
+    def __init__(self) -> None:
         """Generic metadata class __init__, not be used directly."""
-        self._required = {}
+        self._required: dict[str, Any] = {}
         self._optional = _OptionalMetaData()
         self._freeform = {}
 
         self._freeform = {"smda": "whatever"}
 
-    def get_metadata(self):
+    def get_metadata(self) -> dict[str, Any]:
         """Get all metadata that are present."""
         allmeta = {}
         allmeta["_required_"] = self._required
@@ -157,7 +170,7 @@ class MetaData:
         return allmeta
 
     @property
-    def optional(self):
+    def optional(self) -> dict[str, Any]:
         """Return or set optional metadata.
 
         When setting optional names, it can be done in several ways...
@@ -169,7 +182,7 @@ class MetaData:
         return self._optional.get_meta()
 
     @optional.setter
-    def optional(self, indict):
+    def optional(self, indict: dict[str, Any]) -> None:
         # setting the optional key, including validation
         if not isinstance(indict, dict):
             raise ValueError(f"Input must be a dictionary, not a {type(indict)}")
@@ -178,7 +191,7 @@ class MetaData:
             setattr(self._optional, "_" + key, value)
 
     @property
-    def opt(self):
+    def opt(self) -> _OptionalMetaData:
         """Return the metadata optional instance.
 
         This makes access to the _OptionalMetaData instance.
@@ -191,26 +204,17 @@ class MetaData:
         """
         return self._optional
 
-    @optional.setter
-    def optional(self, indict):
-        # setting the optional key, including validation
-        if not isinstance(indict, dict):
-            raise ValueError(f"Input must be a dictionary, not a {type(indict)}")
-
-        for key, value in indict.items():
-            setattr(self._optional, "_" + key, value)
-
     @property
-    def freeform(self):
+    def freeform(self) -> dict[str, Any]:
         """Get or set the current freeform metadata dictionary."""
         return self._freeform
 
     @freeform.setter
-    def freeform(self, adict):
+    def freeform(self, adict: dict[str, Any]) -> None:
         """Freeform is a whatever you want set, without any validation."""
         self._freeform = adict.copy()
 
-    def generate_fmu_name(self):
+    def generate_fmu_name(self) -> str:
         """Generate FMU name on form xxxx--yyyy--date but no suffix."""
         fname = ""
         first = "prefix"
@@ -226,7 +230,7 @@ class MetaData:
 class MetaDataRegularSurface(MetaData):
     """Metadata for RegularSurface() objects."""
 
-    REQUIRED = {
+    REQUIRED: dict[str, Any] = {
         "ncol": 1,
         "nrow": 1,
         "xori": 0.0,
@@ -238,20 +242,20 @@ class MetaDataRegularSurface(MetaData):
         "undef": UNDEF,
     }
 
-    def __init__(self):
+    def __init__(self) -> None:
         """Docstring."""
         super().__init__()
-        self._required = __class__.REQUIRED
+        self._required = self.REQUIRED
         self._optional._datatype = "Regular Surface"
 
     @property
-    def required(self):
+    def required(self) -> dict[str, Any]:
         """Get of set required metadata."""
         return self._required
 
     @required.setter
-    def required(self, obj):
-        if not isinstance(obj, xtgeo.RegularSurface):
+    def required(self, obj: RegularSurface) -> None:
+        if not isinstance(obj, xtgeo.RegularSurface):  # type: ignore[attr-defined]
             raise ValueError("Input object is not a RegularSurface()")
 
         self._required["ncol"] = obj.ncol
@@ -269,7 +273,7 @@ class MetaDataRegularCube(MetaData):
     """Metadata for Cube() objects."""
 
     # allowed optional keys; these are set to avoid discussions
-    REQUIRED = {
+    REQUIRED: dict[str, Any] = {
         "ncol": 1,
         "nrow": 1,
         "nlay": 1,
@@ -285,20 +289,20 @@ class MetaDataRegularCube(MetaData):
         "undef": UNDEF,
     }
 
-    def __init__(self):
+    def __init__(self) -> None:
         """Docstring."""
         super().__init__()
-        self._required = __class__.REQUIRED
+        self._required = self.REQUIRED
         self._optional._datatype = "Regular Cube"
 
     @property
-    def required(self):
+    def required(self) -> dict[str, Any]:
         """Get of set required metadata."""
         return self._required
 
     @required.setter
-    def required(self, obj):
-        if not isinstance(obj, xtgeo.Cube):
+    def required(self, obj: Cube) -> None:
+        if not isinstance(obj, xtgeo.Cube):  # type: ignore[attr-defined]
             raise ValueError("Input object is not a regular Cube()")
 
         self._required["ncol"] = obj.ncol
@@ -319,7 +323,7 @@ class MetaDataRegularCube(MetaData):
 class MetaDataCPGeometry(MetaData):
     """Metadata for Grid() objects of type simplified CornerPoint Geometry."""
 
-    REQUIRED = {
+    REQUIRED: dict[str, Any] = {
         "ncol": 1,
         "nrow": 1,
         "nlay": 1,
@@ -331,20 +335,20 @@ class MetaDataCPGeometry(MetaData):
         "zscale": 1.0,
     }
 
-    def __init__(self):
+    def __init__(self) -> None:
         """Docstring."""
         super().__init__()
-        self._required = __class__.REQUIRED
+        self._required = self.REQUIRED
         self._optional._datatype = "CornerPoint GridGeometry"
 
     @property
-    def required(self):
+    def required(self) -> dict[str, Any]:
         """Get of set required metadata."""
         return self._required
 
     @required.setter
-    def required(self, obj):
-        if not isinstance(obj, xtgeo.Grid):
+    def required(self, obj: Grid) -> None:
+        if not isinstance(obj, xtgeo.Grid):  # type: ignore[attr-defined]
             raise ValueError("Input object is not a Grid()")
 
         self._required["ncol"] = obj.ncol
@@ -362,7 +366,7 @@ class MetaDataCPGeometry(MetaData):
 class MetaDataCPProperty(MetaData):
     """Metadata for GridProperty() objects belonging to CPGeometry."""
 
-    REQUIRED = {
+    REQUIRED: dict[str, Any] = {
         "ncol": 1,
         "nrow": 1,
         "nlay": 1,
@@ -370,20 +374,20 @@ class MetaDataCPProperty(MetaData):
         "discrete": False,
     }
 
-    def __init__(self):
+    def __init__(self) -> None:
         """Docstring."""
         super().__init__()
-        self._required = __class__.REQUIRED
+        self._required = self.REQUIRED
         self._optional._datatype = "CornerPoint GridProperty"
 
     @property
-    def required(self):
+    def required(self) -> dict[str, Any]:
         """Get of set required metadata."""
         return self._required
 
     @required.setter
-    def required(self, obj):
-        if not isinstance(obj, xtgeo.GridProperty):
+    def required(self, obj: GridProperty) -> None:
+        if not isinstance(obj, xtgeo.GridProperty):  # type: ignore[attr-defined]
             raise ValueError("Input object is not a GridProperty()")
 
         self._required["ncol"] = obj.ncol
@@ -396,7 +400,7 @@ class MetaDataCPProperty(MetaData):
 class MetaDataWell(MetaData):
     """Metadata for single Well() objects."""
 
-    REQUIRED = {
+    REQUIRED: dict[str, Any] = {
         "rkb": 0.0,
         "xpos": 0.0,
         "ypos": 0.0,
@@ -406,20 +410,20 @@ class MetaDataWell(MetaData):
         "zonelogname": None,
     }
 
-    def __init__(self):
+    def __init__(self) -> None:
         """Initialisation for Well metadata."""
         super().__init__()
-        self._required = __class__.REQUIRED
+        self._required = self.REQUIRED
         self._optional._datatype = "Well"
 
     @property
-    def required(self):
+    def required(self) -> dict[str, Any]:
         """Get of set required metadata."""
         return self._required
 
     @required.setter
-    def required(self, obj):
-        if not isinstance(obj, xtgeo.Well):
+    def required(self, obj: Well) -> None:
+        if not isinstance(obj, xtgeo.Well):  # type: ignore[attr-defined]
             raise ValueError("Input object is not a Well() instance!")
 
         self._required["rkb"] = obj.rkb

xtgeo/share/eigen3/cmake/Eigen3Config.cmake

@@ -0,0 +1,37 @@
+# This file exports the Eigen3::Eigen CMake target which should be passed to the
+# target_link_libraries command.
+
+
+####### Expanded from @PACKAGE_INIT@ by configure_package_config_file() #######
+####### Any changes to this file will be overwritten by the next CMake run ####
+####### The input file was Eigen3Config.cmake.in                            ########
+
+get_filename_component(PACKAGE_PREFIX_DIR "${CMAKE_CURRENT_LIST_DIR}/../../../" ABSOLUTE)
+
+macro(set_and_check _var _file)
+  set(${_var} "${_file}")
+  if(NOT EXISTS "${_file}")
+    message(FATAL_ERROR "File or directory ${_file} referenced by variable ${_var} does not exist !")
+  endif()
+endmacro()
+
+####################################################################################
+
+if (NOT TARGET eigen)
+  include ("${CMAKE_CURRENT_LIST_DIR}/Eigen3Targets.cmake")
+endif ()
+
+# Legacy variables, do *not* use. May be removed in the future.
+
+set (EIGEN3_FOUND 1)
+set (EIGEN3_USE_FILE    "${CMAKE_CURRENT_LIST_DIR}/UseEigen3.cmake")
+
+set (EIGEN3_DEFINITIONS  "")
+set (EIGEN3_INCLUDE_DIR  "${PACKAGE_PREFIX_DIR}/include/eigen3")
+set (EIGEN3_INCLUDE_DIRS "${PACKAGE_PREFIX_DIR}/include/eigen3")
+set (EIGEN3_ROOT_DIR     "${PACKAGE_PREFIX_DIR}")
+
+set (EIGEN3_VERSION_STRING "3.4.0")
+set (EIGEN3_VERSION_MAJOR  "3")
+set (EIGEN3_VERSION_MINOR  "4")
+set (EIGEN3_VERSION_PATCH  "0")

xtgeo/share/eigen3/cmake/Eigen3ConfigVersion.cmake

@@ -0,0 +1,65 @@
+# This is a basic version file for the Config-mode of find_package().
+# It is used by write_basic_package_version_file() as input file for configure_file()
+# to create a version-file which can be installed along a config.cmake file.
+#
+# The created file sets PACKAGE_VERSION_EXACT if the current version string and
+# the requested version string are exactly the same and it sets
+# PACKAGE_VERSION_COMPATIBLE if the current version is >= requested version,
+# but only if the requested major version is the same as the current one.
+# The variable CVF_VERSION must be set before calling configure_file().
+
+
+set(PACKAGE_VERSION "3.4.0")
+
+if(PACKAGE_VERSION VERSION_LESS PACKAGE_FIND_VERSION)
+  set(PACKAGE_VERSION_COMPATIBLE FALSE)
+else()
+
+  if("3.4.0" MATCHES "^([0-9]+)\\.")
+    set(CVF_VERSION_MAJOR "${CMAKE_MATCH_1}")
+    if(NOT CVF_VERSION_MAJOR VERSION_EQUAL 0)
+      string(REGEX REPLACE "^0+" "" CVF_VERSION_MAJOR "${CVF_VERSION_MAJOR}")
+    endif()
+  else()
+    set(CVF_VERSION_MAJOR "3.4.0")
+  endif()
+
+  if(PACKAGE_FIND_VERSION_RANGE)
+    # both endpoints of the range must have the expected major version
+    math (EXPR CVF_VERSION_MAJOR_NEXT "${CVF_VERSION_MAJOR} + 1")
+    if (NOT PACKAGE_FIND_VERSION_MIN_MAJOR STREQUAL CVF_VERSION_MAJOR
+        OR ((PACKAGE_FIND_VERSION_RANGE_MAX STREQUAL "INCLUDE" AND NOT PACKAGE_FIND_VERSION_MAX_MAJOR STREQUAL CVF_VERSION_MAJOR)
+          OR (PACKAGE_FIND_VERSION_RANGE_MAX STREQUAL "EXCLUDE" AND NOT PACKAGE_FIND_VERSION_MAX VERSION_LESS_EQUAL CVF_VERSION_MAJOR_NEXT)))
+      set(PACKAGE_VERSION_COMPATIBLE FALSE)
+    elseif(PACKAGE_FIND_VERSION_MIN_MAJOR STREQUAL CVF_VERSION_MAJOR
+        AND ((PACKAGE_FIND_VERSION_RANGE_MAX STREQUAL "INCLUDE" AND PACKAGE_VERSION VERSION_LESS_EQUAL PACKAGE_FIND_VERSION_MAX)
+        OR (PACKAGE_FIND_VERSION_RANGE_MAX STREQUAL "EXCLUDE" AND PACKAGE_VERSION VERSION_LESS PACKAGE_FIND_VERSION_MAX)))
+      set(PACKAGE_VERSION_COMPATIBLE TRUE)
+    else()
+      set(PACKAGE_VERSION_COMPATIBLE FALSE)
+    endif()
+  else()
+    if(PACKAGE_FIND_VERSION_MAJOR STREQUAL CVF_VERSION_MAJOR)
+      set(PACKAGE_VERSION_COMPATIBLE TRUE)
+    else()
+      set(PACKAGE_VERSION_COMPATIBLE FALSE)
+    endif()
+
+    if(PACKAGE_FIND_VERSION STREQUAL PACKAGE_VERSION)
+      set(PACKAGE_VERSION_EXACT TRUE)
+    endif()
+  endif()
+endif()
+
+
+# if the installed or the using project don't have CMAKE_SIZEOF_VOID_P set, ignore it:
+if("${CMAKE_SIZEOF_VOID_P}" STREQUAL "" OR "" STREQUAL "")
+  return()
+endif()
+
+# check that the installed version has the same 32/64bit-ness as the one which is currently searching:
+if(NOT CMAKE_SIZEOF_VOID_P STREQUAL "")
+  math(EXPR installedBits " * 8")
+  set(PACKAGE_VERSION "${PACKAGE_VERSION} (${installedBits}bit)")
+  set(PACKAGE_VERSION_UNSUITABLE TRUE)
+endif()

xtgeo/share/eigen3/cmake/Eigen3Targets.cmake

@@ -0,0 +1,106 @@
+# Generated by CMake
+
+if("${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION}" LESS 2.8)
+   message(FATAL_ERROR "CMake >= 3.0.0 required")
+endif()
+if(CMAKE_VERSION VERSION_LESS "3.0.0")
+   message(FATAL_ERROR "CMake >= 3.0.0 required")
+endif()
+cmake_policy(PUSH)
+cmake_policy(VERSION 3.0.0...3.31)
+#----------------------------------------------------------------
+# Generated CMake target import file.
+#----------------------------------------------------------------
+
+# Commands may need to know the format version.
+set(CMAKE_IMPORT_FILE_VERSION 1)
+
+# Protect against multiple inclusion, which would fail when already imported targets are added once more.
+set(_cmake_targets_defined "")
+set(_cmake_targets_not_defined "")
+set(_cmake_expected_targets "")
+foreach(_cmake_expected_target IN ITEMS Eigen3::Eigen)
+  list(APPEND _cmake_expected_targets "${_cmake_expected_target}")
+  if(TARGET "${_cmake_expected_target}")
+    list(APPEND _cmake_targets_defined "${_cmake_expected_target}")
+  else()
+    list(APPEND _cmake_targets_not_defined "${_cmake_expected_target}")
+  endif()
+endforeach()
+unset(_cmake_expected_target)
+if(_cmake_targets_defined STREQUAL _cmake_expected_targets)
+  unset(_cmake_targets_defined)
+  unset(_cmake_targets_not_defined)
+  unset(_cmake_expected_targets)
+  unset(CMAKE_IMPORT_FILE_VERSION)
+  cmake_policy(POP)
+  return()
+endif()
+if(NOT _cmake_targets_defined STREQUAL "")
+  string(REPLACE ";" ", " _cmake_targets_defined_text "${_cmake_targets_defined}")
+  string(REPLACE ";" ", " _cmake_targets_not_defined_text "${_cmake_targets_not_defined}")
+  message(FATAL_ERROR "Some (but not all) targets in this export set were already defined.\nTargets Defined: ${_cmake_targets_defined_text}\nTargets not yet defined: ${_cmake_targets_not_defined_text}\n")
+endif()
+unset(_cmake_targets_defined)
+unset(_cmake_targets_not_defined)
+unset(_cmake_expected_targets)
+
+
+# Compute the installation prefix relative to this file.
+get_filename_component(_IMPORT_PREFIX "${CMAKE_CURRENT_LIST_FILE}" PATH)
+get_filename_component(_IMPORT_PREFIX "${_IMPORT_PREFIX}" PATH)
+get_filename_component(_IMPORT_PREFIX "${_IMPORT_PREFIX}" PATH)
+get_filename_component(_IMPORT_PREFIX "${_IMPORT_PREFIX}" PATH)
+if(_IMPORT_PREFIX STREQUAL "/")
+  set(_IMPORT_PREFIX "")
+endif()
+
+# Create imported target Eigen3::Eigen
+add_library(Eigen3::Eigen INTERFACE IMPORTED)
+
+set_target_properties(Eigen3::Eigen PROPERTIES
+  INTERFACE_INCLUDE_DIRECTORIES "${_IMPORT_PREFIX}/include/eigen3"
+)
+
+# Load information for each installed configuration.
+file(GLOB _cmake_config_files "${CMAKE_CURRENT_LIST_DIR}/Eigen3Targets-*.cmake")
+foreach(_cmake_config_file IN LISTS _cmake_config_files)
+  include("${_cmake_config_file}")
+endforeach()
+unset(_cmake_config_file)
+unset(_cmake_config_files)
+
+# Cleanup temporary variables.
+set(_IMPORT_PREFIX)
+
+# Loop over all imported files and verify that they actually exist
+foreach(_cmake_target IN LISTS _cmake_import_check_targets)
+  if(CMAKE_VERSION VERSION_LESS "3.28"
+      OR NOT DEFINED _cmake_import_check_xcframework_for_${_cmake_target}
+      OR NOT IS_DIRECTORY "${_cmake_import_check_xcframework_for_${_cmake_target}}")
+    foreach(_cmake_file IN LISTS "_cmake_import_check_files_for_${_cmake_target}")
+      if(NOT EXISTS "${_cmake_file}")
+        message(FATAL_ERROR "The imported target \"${_cmake_target}\" references the file
+   \"${_cmake_file}\"
+but this file does not exist.  Possible reasons include:
+* The file was deleted, renamed, or moved to another location.
+* An install or uninstall procedure did not complete successfully.
+* The installation package was faulty and contained
+   \"${CMAKE_CURRENT_LIST_FILE}\"
+but not all the files it references.
+")
+      endif()
+    endforeach()
+  endif()
+  unset(_cmake_file)
+  unset("_cmake_import_check_files_for_${_cmake_target}")
+endforeach()
+unset(_cmake_target)
+unset(_cmake_import_check_targets)
+
+# This file does not depend on other imported targets which have
+# been exported from the same project but in a separate export set.
+
+# Commands beyond this point should not need to know the version.
+set(CMAKE_IMPORT_FILE_VERSION)
+cmake_policy(POP)

xtgeo/share/eigen3/cmake/UseEigen3.cmake

@@ -0,0 +1,6 @@
+#                                               -*- cmake -*-
+#
+#  UseEigen3.cmake
+
+add_definitions     ( ${EIGEN3_DEFINITIONS} )
+include_directories ( ${EIGEN3_INCLUDE_DIRS} )

xtgeo/share/pkgconfig/eigen3.pc

@@ -0,0 +1,9 @@
+prefix=/var/folders/6c/pzd640_546q6_yfn24r65c_40000gn/T/tmp_ypjt9ow/wheel/platlib/xtgeo
+exec_prefix=${prefix}
+
+Name: Eigen3
+Description: A C++ template library for linear algebra: vectors, matrices, and related algorithms
+Requires:
+Version: 3.4.0
+Libs:
+Cflags: -I${prefix}/include/eigen3

xtgeo/surface/__init__.py

@@ -4,6 +4,7 @@ from .regular_surface import (
     RegularSurface,
     surface_from_file,
     surface_from_grid3d,
+    surface_from_rms,
     surface_from_roxar,
 )
 from .surfaces import Surfaces, surfaces_from_grid
@@ -11,6 +12,7 @@ from .surfaces import Surfaces, surfaces_from_grid
 __all__ = [
     "RegularSurface",
     "surface_from_file",
+    "surface_from_rms",
     "surface_from_roxar",
     "surface_from_grid3d",
     "Surfaces",