MAINT: Restructure models and schemas

docs/src/conf.py

@@ -53,7 +53,7 @@ def filter(self, record: logging.LogRecord) -> bool:
 apidoc_output_dir = "apiref"
 apidoc_excluded_paths = [
     "case",
-    "datastructure",
+    "_models",
     "hook_implementations",
     "providers",
     "scripts",

docs/src/datamodel/index.rst

@@ -32,8 +32,8 @@ documentation of these two models can be inspected from here.
    .. toctree::
       :maxdepth: -1
 
-      ~fmu.dataio._model.root.ObjectMetadata
-      ~fmu.dataio._model.root.CaseMetadata
+      ~fmu.dataio._models._fmu_results.fmu_results.ObjectMetadata
+      ~fmu.dataio._models._fmu_results.fmu_results.CaseMetadata
 
 
 About the data model

docs/src/rms_oneliners.rst

@@ -9,8 +9,9 @@ a few lines will be needed.
 Currently only volumes are exposed, but this will be extended in the near future.
 
 .. note::
-All simplified export functions requires that the global configuration file is found at the standard
-location in FMU. For RMS exports that will be ``'../../fmuconfig/output/global_variables.yml'``.
+
+    All simplified export functions requires that the global configuration file is found at the standard
+    location in FMU. For RMS exports that will be ``'../../fmuconfig/output/global_variables.yml'``.
 
 .. _example-export-volumes-rms:
 

schemas/0.8.0/fmu_results.json

@@ -10885,5 +10885,5 @@
       }
     }
   },
-  "title": "Root"
+  "title": "FmuResults"
 }

src/fmu/dataio/_metadata.py

@@ -19,11 +19,15 @@
 )
 
 from ._logging import null_logger
-from ._model import data, fields
-from ._model.enums import FMUClass
-from ._model.global_configuration import GlobalConfiguration
-from ._model.product import Product
-from ._model.root import CaseMetadata, FmuResultsSchema, ObjectMetadata
+from ._models._fmu_results import data, fields
+from ._models._fmu_results.enums import FMUClass
+from ._models._fmu_results.fmu_results import (
+    CaseMetadata,
+    FmuResultsSchema,
+    ObjectMetadata,
+)
+from ._models._fmu_results.global_configuration import GlobalConfiguration
+from ._models._fmu_results.product import Product
 from .exceptions import InvalidMetadataError
 from .providers._filedata import FileDataProvider
 from .providers.objectdata._base import UnsetData

src/fmu/dataio/_models/__init__.py

@@ -0,0 +1,8 @@
+from ._fmu_results import FmuResults, FmuResultsSchema
+from ._products import InplaceVolumesSchema
+
+__all__ = [
+    "InplaceVolumesSchema",
+    "FmuResultsSchema",
+    "FmuResults",
+]

src/fmu/dataio/_models/_fmu_results/__init__.py

@@ -0,0 +1,6 @@
+from .fmu_results import FmuResults, FmuResultsSchema
+
+__all__ = [
+    "FmuResultsSchema",
+    "FmuResults",
+]

src/fmu/dataio/_model/root.py → src/fmu/dataio/_models/_fmu_results/fmu_results.py

@@ -129,7 +129,7 @@ def generate(
 
     @staticmethod
     def dump() -> dict[str, Any]:
-        return Root.model_json_schema(
+        return FmuResults.model_json_schema(
             schema_generator=FmuResultsSchema.FmuResultsGenerateJsonSchema
         )
 
@@ -252,7 +252,7 @@ class ObjectMetadata(MetadataBase):
     should/could be displayed. See :class:`Display`."""
 
 
-class Root(
+class FmuResults(
     RootModel[
         Annotated[
             Union[
@@ -266,7 +266,7 @@ class Root(
     ]
 ):
     @model_validator(mode="after")
-    def _check_class_data_spec(self) -> Root:
+    def _check_class_data_spec(self) -> FmuResults:
         if (
             self.root.class_ in (FMUClass.table, FMUClass.surface)
             and hasattr(self.root, "data")

src/fmu/dataio/_model/product.py → src/fmu/dataio/_models/_fmu_results/product.py

@@ -10,7 +10,7 @@
 )
 from typing_extensions import Annotated
 
-from fmu.dataio._products import InplaceVolumesSchema
+from fmu.dataio._models._products import InplaceVolumesSchema
 
 from . import enums
 

src/fmu/dataio/aggregation.py

@@ -8,12 +8,12 @@
 
 from pydantic import ValidationError
 
-from fmu.dataio._model import fields
+from fmu.dataio._models._fmu_results import fields
 
 from . import _utils, dataio, types
 from ._logging import null_logger
 from ._metadata import ObjectMetadataExport
-from ._model.enums import FMUContext
+from ._models._fmu_results.enums import FMUContext
 from .exceptions import InvalidMetadataError
 from .providers.objectdata._provider import objectdata_provider_factory
 

src/fmu/dataio/case.py

@@ -9,13 +9,13 @@
 
 from pydantic import ValidationError
 
-from fmu.dataio._model import fields
+from fmu.dataio._models._fmu_results import fields
 
 from . import _utils
 from ._logging import null_logger
 from ._metadata import CaseMetadataExport
-from ._model import global_configuration
-from ._model.fields import Access, Case, Masterdata, Model, User
+from ._models._fmu_results import global_configuration
+from ._models._fmu_results.fields import Access, Case, Masterdata, Model, User
 
 logger: Final = null_logger(__name__)
 

src/fmu/dataio/dataio.py

@@ -28,9 +28,9 @@
 from ._definitions import ValidationError
 from ._logging import null_logger
 from ._metadata import generate_export_metadata
-from ._model import enums, global_configuration
-from ._model.global_configuration import GlobalConfiguration
-from ._model.product import Product
+from ._models._fmu_results import enums, global_configuration
+from ._models._fmu_results.global_configuration import GlobalConfiguration
+from ._models._fmu_results.product import Product
 from ._utils import (
     detect_inside_rms,  # dataio_examples,
     export_file,

src/fmu/dataio/export/rms/inplace_volumes.py

@@ -11,9 +11,9 @@
 
 import fmu.dataio as dio
 from fmu.dataio._logging import null_logger
-from fmu.dataio._model import product
-from fmu.dataio._model.enums import Classification, ProductName
-from fmu.dataio._products.inplace_volumes import InplaceVolumesResult
+from fmu.dataio._models._fmu_results import product
+from fmu.dataio._models._fmu_results.enums import Classification, ProductName
+from fmu.dataio._models._products.inplace_volumes import InplaceVolumesResult
 from fmu.dataio.export import _enums
 from fmu.dataio.export._decorators import experimental
 from fmu.dataio.export._export_result import ExportResult, ExportResultItem

src/fmu/dataio/preprocessed.py

@@ -11,9 +11,9 @@
 
 from ._logging import null_logger
 from ._metadata import ObjectMetadataExport
-from ._model import enums
-from ._model.enums import FMUContext
-from ._model.fields import File
+from ._models._fmu_results import enums
+from ._models._fmu_results.enums import FMUContext
+from ._models._fmu_results.fields import File
 from ._utils import export_metadata_file, md5sum
 from .exceptions import InvalidMetadataError
 from .providers._filedata import ShareFolder

src/fmu/dataio/providers/_filedata.py

@@ -14,7 +14,7 @@
 from typing import TYPE_CHECKING, Final
 
 from fmu.dataio._logging import null_logger
-from fmu.dataio._model import enums, fields
+from fmu.dataio._models._fmu_results import enums, fields
 from fmu.dataio._utils import compute_md5, compute_md5_using_temp_file
 
 from ._base import Provider

src/fmu/dataio/providers/_fmu.py

@@ -42,8 +42,8 @@
 from fmu.dataio import _utils
 from fmu.dataio._logging import null_logger
 from fmu.dataio._metadata import CaseMetadataExport
-from fmu.dataio._model import fields
-from fmu.dataio._model.enums import ErtSimulationMode, FMUContext
+from fmu.dataio._models._fmu_results import fields
+from fmu.dataio._models._fmu_results.enums import ErtSimulationMode, FMUContext
 from fmu.dataio.exceptions import InvalidMetadataError
 
 from ._base import Provider

src/fmu/dataio/providers/objectdata/_base.py

@@ -8,13 +8,13 @@
 
 from fmu.dataio._definitions import ConfigurationError, ValidFormats
 from fmu.dataio._logging import null_logger
-from fmu.dataio._model.data import AnyData, Time, Timestamp
-from fmu.dataio._model.enums import Content
-from fmu.dataio._model.global_configuration import (
+from fmu.dataio._models._fmu_results.data import AnyData, Time, Timestamp
+from fmu.dataio._models._fmu_results.enums import Content
+from fmu.dataio._models._fmu_results.global_configuration import (
     GlobalConfiguration,
     StratigraphyElement,
 )
-from fmu.dataio._model.product import Product
+from fmu.dataio._models._fmu_results.product import Product
 from fmu.dataio._utils import generate_description
 from fmu.dataio.providers._base import Provider
 from fmu.dataio.providers.objectdata._export_models import AllowedContent, UnsetData
@@ -25,8 +25,8 @@
         BoundingBox3D,
         Geometry,
     )
-    from fmu.dataio._model.enums import FMUClass, Layout
-    from fmu.dataio._model.specification import AnySpecification
+    from fmu.dataio._models._fmu_results.enums import FMUClass, Layout
+    from fmu.dataio._models._fmu_results.specification import AnySpecification
     from fmu.dataio.dataio import ExportData
     from fmu.dataio.types import Inferrable
 

src/fmu/dataio/providers/objectdata/_export_models.py

@@ -18,7 +18,7 @@
 )
 
 from fmu.dataio._logging import null_logger
-from fmu.dataio._model import data, enums
+from fmu.dataio._models._fmu_results import data, enums
 
 logger: Final = null_logger(__name__)
 

src/fmu/dataio/providers/objectdata/_faultroom.py

@@ -5,12 +5,12 @@
 
 from fmu.dataio._definitions import ExportFolder, ValidFormats
 from fmu.dataio._logging import null_logger
-from fmu.dataio._model.data import BoundingBox3D
-from fmu.dataio._model.enums import FMUClass, Layout
-from fmu.dataio._model.global_configuration import (
+from fmu.dataio._models._fmu_results.data import BoundingBox3D
+from fmu.dataio._models._fmu_results.enums import FMUClass, Layout
+from fmu.dataio._models._fmu_results.global_configuration import (
     GlobalConfiguration,
 )
-from fmu.dataio._model.specification import FaultRoomSurfaceSpecification
+from fmu.dataio._models._fmu_results.specification import FaultRoomSurfaceSpecification
 from fmu.dataio.providers.objectdata._utils import Utils
 
 from ._base import (

src/fmu/dataio/providers/objectdata/_provider.py

@@ -95,8 +95,8 @@
 
 from fmu.dataio._definitions import ExportFolder, ValidFormats
 from fmu.dataio._logging import null_logger
-from fmu.dataio._model.enums import FMUClass, Layout
-from fmu.dataio._model.product import Product
+from fmu.dataio._models._fmu_results.enums import FMUClass, Layout
+from fmu.dataio._models._fmu_results.product import Product
 from fmu.dataio.readers import FaultRoomSurface
 
 from ._base import (

src/fmu/dataio/providers/objectdata/_tables.py

@@ -9,8 +9,8 @@
     ValidFormats,
 )
 from fmu.dataio._logging import null_logger
-from fmu.dataio._model.enums import FMUClass, Layout
-from fmu.dataio._model.specification import TableSpecification
+from fmu.dataio._models._fmu_results.enums import FMUClass, Layout
+from fmu.dataio._models._fmu_results.specification import TableSpecification
 
 from ._base import (
     ObjectDataProvider,

src/fmu/dataio/providers/objectdata/_utils.py

@@ -2,7 +2,7 @@
 
 import warnings
 
-from fmu.dataio._model.global_configuration import Stratigraphy
+from fmu.dataio._models._fmu_results.global_configuration import Stratigraphy
 
 
 class Utils:

src/fmu/dataio/providers/objectdata/_xtgeo.py

@@ -9,9 +9,9 @@
 
 from fmu.dataio._definitions import ExportFolder, ValidFormats
 from fmu.dataio._logging import null_logger
-from fmu.dataio._model.data import BoundingBox2D, BoundingBox3D, Geometry
-from fmu.dataio._model.enums import FMUClass, Layout
-from fmu.dataio._model.specification import (
+from fmu.dataio._models._fmu_results.data import BoundingBox2D, BoundingBox3D, Geometry
+from fmu.dataio._models._fmu_results.enums import FMUClass, Layout
+from fmu.dataio._models._fmu_results.specification import (
     CPGridPropertySpecification,
     CPGridSpecification,
     CubeSpecification,

tests/conftest.py

@@ -16,7 +16,7 @@
 
 import fmu.dataio as dio
 from fmu.config import utilities as ut
-from fmu.dataio._model import Root, fields, global_configuration
+from fmu.dataio._models._fmu_results import FmuResults, fields, global_configuration
 from fmu.dataio.dataio import ExportData, read_metadata
 from fmu.dataio.providers._fmu import FmuEnv
 from fmu.dataio.readers import FaultRoomSurface
@@ -750,5 +750,5 @@ def fixture_drogon_volumes(rootpath):
 
 @pytest.fixture(scope="session")
 def pydantic_models_from_root():
-    """Return all nested pydantic models from Root and downwards"""
-    return _get_nested_pydantic_models(Root)
+    """Return all nested pydantic models from FmuResults and downwards"""
+    return _get_nested_pydantic_models(FmuResults)

tests/test_export_rms/test_export_rms_volumetrics.py

@@ -12,8 +12,8 @@
 
 from fmu import dataio
 from fmu.dataio._logging import null_logger
-from fmu.dataio._model.enums import ProductName
-from fmu.dataio._products.inplace_volumes import (
+from fmu.dataio._models._fmu_results.enums import ProductName
+from fmu.dataio._models._products.inplace_volumes import (
     InplaceVolumesResult,
     InplaceVolumesResultRow,
     InplaceVolumesSchema,

tests/test_integration/test_simple_export_run.py

@@ -6,8 +6,8 @@
 import pytest
 import yaml
 
-from fmu.dataio._model import Root
-from fmu.dataio._model.enums import ErtSimulationMode
+from fmu.dataio._models._fmu_results import FmuResults
+from fmu.dataio._models._fmu_results.enums import ErtSimulationMode
 
 from .ert_config_utils import (
     add_create_case_workflow,
@@ -57,6 +57,6 @@ def test_simple_export_ert_environment_variables(snakeoil_export_surface: Path)
     with open(avg_poro_yml, encoding="utf-8") as f:
         avg_poro_metadata = yaml.safe_load(f)
 
-    avg_poro = Root.model_validate(avg_poro_metadata)  # asserts valid
+    avg_poro = FmuResults.model_validate(avg_poro_metadata)  # asserts valid
     assert avg_poro.root.fmu.ert.simulation_mode == ErtSimulationMode.test_run
     assert avg_poro.root.fmu.ert.experiment.id is not None