OpenGeodeWeb-Back 6.17.0rc2__tar.gz → 6.17.0rc3__tar.gz

{opengeodeweb_back-6.17.0rc2 → opengeodeweb_back-6.17.0rc3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: OpenGeodeWeb-Back
-Version: 6.17.0rc2
+Version: 6.17.0rc3
 Summary: OpenGeodeWeb-Back is an open source framework that proposes handy python functions and wrappers for the OpenGeode ecosystem
 Author-email: Geode-solutions <team-web@geode-solutions.com>
 Project-URL: Homepage, https://github.com/Geode-solutions/OpenGeodeWeb-Back

{opengeodeweb_back-6.17.0rc2 → opengeodeweb_back-6.17.0rc3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "OpenGeodeWeb-Back"
-version = "6.17.0-rc.2"
+version = "6.17.0-rc.3"
 dynamic = ["dependencies"]
 authors = [{ name = "Geode-solutions", email = "team-web@geode-solutions.com" }]
 description = "OpenGeodeWeb-Back is an open source framework that proposes handy python functions and wrappers for the OpenGeode ecosystem"

{opengeodeweb_back-6.17.0rc2 → opengeodeweb_back-6.17.0rc3}/src/OpenGeodeWeb_Back.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: OpenGeodeWeb-Back
-Version: 6.17.0rc2
+Version: 6.17.0rc3
 Summary: OpenGeodeWeb-Back is an open source framework that proposes handy python functions and wrappers for the OpenGeode ecosystem
 Author-email: Geode-solutions <team-web@geode-solutions.com>
 Project-URL: Homepage, https://github.com/Geode-solutions/OpenGeodeWeb-Back

{opengeodeweb_back-6.17.0rc2 → opengeodeweb_back-6.17.0rc3}/src/OpenGeodeWeb_Back.egg-info/SOURCES.txt

@@ -74,6 +74,8 @@ src/opengeodeweb_back/routes/create/blueprint_create.py
 src/opengeodeweb_back/routes/create/schemas/__init__.py
 src/opengeodeweb_back/routes/create/schemas/edged_curve.json
 src/opengeodeweb_back/routes/create/schemas/edged_curve.py
+src/opengeodeweb_back/routes/create/schemas/horizon_stack.json
+src/opengeodeweb_back/routes/create/schemas/horizon_stack.py
 src/opengeodeweb_back/routes/create/schemas/point_set.json
 src/opengeodeweb_back/routes/create/schemas/point_set.py
 src/opengeodeweb_back/routes/create/schemas/polygonal_surface.json
@@ -114,6 +116,8 @@ src/opengeodeweb_back/routes/schemas/geode_object_inheritance.json
 src/opengeodeweb_back/routes/schemas/geode_object_inheritance.py
 src/opengeodeweb_back/routes/schemas/geode_objects_and_output_extensions.json
 src/opengeodeweb_back/routes/schemas/geode_objects_and_output_extensions.py
+src/opengeodeweb_back/routes/schemas/horizon_stack_info.json
+src/opengeodeweb_back/routes/schemas/horizon_stack_info.py
 src/opengeodeweb_back/routes/schemas/import_project.json
 src/opengeodeweb_back/routes/schemas/import_project.py
 src/opengeodeweb_back/routes/schemas/kill.json

{opengeodeweb_back-6.17.0rc2 → opengeodeweb_back-6.17.0rc3}/src/opengeodeweb_back/routes/blueprint_routes.py

@@ -35,6 +35,7 @@ from opengeodeweb_back.geode_objects.geode_brep import GeodeBRep
 from opengeodeweb_back.geode_objects.geode_graph import GeodeGraph
 from opengeodeweb_back.geode_objects.geode_grid2d import GeodeGrid2D
 from opengeodeweb_back.geode_objects.geode_grid3d import GeodeGrid3D
+from opengeodeweb_back.geode_objects.geode_horizon_stack3d import GeodeHorizonStack3D
 from opengeodeweb_back.geode_objects.geode_mesh import GeodeMesh
 from opengeodeweb_back.geode_objects.geode_model import GeodeModel
 from opengeodeweb_back.geode_objects.geode_solid_mesh3d import GeodeSolidMesh3D
@@ -772,6 +773,25 @@ def model_component_polyhedron_attribute_range(
     )
 
 
+@typed_route(routes, schemas.horizon_stack_info_route)
+def horizon_stack_info(params: schemas.HorizonStackInfo) -> schemas.HorizonStackInfoResponse:
+    """Horizons and stratigraphic units of a horizon stack, top to bottom."""
+    geode_object = geode_functions.load_geode_object(params.id)
+    if not isinstance(geode_object, GeodeHorizonStack3D):
+        flask.abort(400, f"{params.id} is not a HorizonStack3D")
+    stack = geode_object.horizon_stack
+    return schemas.HorizonStackInfoResponse(
+        horizons=[
+            schemas.horizon_stack_info.Horizon(id=horizon.id().string(), name=horizon.name() or "")
+            for horizon in stack.top_to_bottom_horizons()
+        ],
+        units=[
+            schemas.horizon_stack_info.Unit(id=unit.id().string(), name=unit.name() or "")
+            for unit in stack.top_to_bottom_units()
+        ],
+    )
+
+
 @typed_route(routes, schemas.ping_route)
 def ping(_params: schemas.Ping) -> schemas.PingResponse:
     flask.current_app.config.update(LAST_PING_TIME=time.time())

{opengeodeweb_back-6.17.0rc2 → opengeodeweb_back-6.17.0rc3}/src/opengeodeweb_back/routes/create/blueprint_create.py

@@ -3,10 +3,12 @@
 # Third party imports
 import flask
 import opengeode
+import opengeode_geosciences
 
 # Local application imports
 from opengeodeweb_back import utils_functions
 from opengeodeweb_back.geode_objects.geode_edged_curve3d import GeodeEdgedCurve3D
+from opengeodeweb_back.geode_objects.geode_horizon_stack3d import GeodeHorizonStack3D
 from opengeodeweb_back.geode_objects.geode_point_set3d import GeodePointSet3D
 from opengeodeweb_back.geode_objects.geode_polygonal_surface3d import (
     GeodePolygonalSurface3D,
@@ -65,3 +67,23 @@ def polygonal_surface(
     return schemas.PolygonalSurfaceResponse.from_dict(
         utils_functions.generate_files_from_object(polygonal_surface_obj)
     )
+
+
+@typed_route(routes, schemas.horizon_stack_route)
+def horizon_stack(params: schemas.HorizonStack) -> schemas.HorizonStackResponse:
+    """Endpoint to create a horizon stack from its horizon and unit names, top to bottom."""
+    if len(params.unit_names) not in (0, len(params.horizons) + 1):
+        flask.abort(
+            400,
+            f"Expected {len(params.horizons) + 1} unit names for {len(params.horizons)} horizons,"
+            f" got {len(params.unit_names)}",
+        )
+    horizon_stack_obj = GeodeHorizonStack3D(
+        opengeode_geosciences.horizons_stack_from_top_to_bottom_names_3d(
+            params.horizons, params.unit_names
+        )
+    )
+    horizon_stack_obj.builder().set_name(params.name)
+    return schemas.HorizonStackResponse.from_dict(
+        utils_functions.generate_files_from_object(horizon_stack_obj)
+    )

{opengeodeweb_back-6.17.0rc2 → opengeodeweb_back-6.17.0rc3}/src/opengeodeweb_back/routes/create/schemas/__init__.py

@@ -1,3 +1,4 @@
 from .polygonal_surface import *
 from .point_set import *
+from .horizon_stack import *
 from .edged_curve import *

opengeodeweb_back-6.17.0rc3/src/opengeodeweb_back/routes/create/schemas/horizon_stack.json

@@ -0,0 +1,192 @@
+{
+  "route": "/horizon_stack",
+  "methods": [
+    "POST"
+  ],
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "minLength": 1
+    },
+    "horizons": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "minLength": 1
+      },
+      "minItems": 1,
+      "uniqueItems": true
+    },
+    "unit_names": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "required": [
+    "name",
+    "horizons",
+    "unit_names"
+  ],
+  "additionalProperties": false,
+  "response": {
+    "type": "object",
+    "properties": {
+      "native_file": {
+        "type": "string"
+      },
+      "id": {
+        "type": "string",
+        "minLength": 32,
+        "maxLength": 32
+      },
+      "name": {
+        "type": "string"
+      },
+      "viewer_type": {
+        "type": "string"
+      },
+      "is_viewable": {
+        "type": "boolean"
+      },
+      "geode_object_type": {
+        "type": "string"
+      },
+      "viewable_file": {
+        "type": "string"
+      },
+      "binary_light_viewable": {
+        "type": "string"
+      },
+      "nb_vertices": {
+        "type": "integer"
+      },
+      "mesh_components": {
+        "type": "array",
+        "items": {
+          "type": "object",
+          "properties": {
+            "viewer_id": {
+              "type": "integer"
+            },
+            "geode_id": {
+              "type": "string",
+              "minLength": 36,
+              "maxLength": 36
+            },
+            "name": {
+              "type": "string"
+            },
+            "type": {
+              "type": "string"
+            },
+            "boundaries": {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "minLength": 36,
+                "maxLength": 36
+              }
+            },
+            "internals": {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "minLength": 36,
+                "maxLength": 36
+              }
+            },
+            "is_active": {
+              "type": "boolean"
+            }
+          },
+          "required": [
+            "viewer_id",
+            "geode_id",
+            "name",
+            "type",
+            "boundaries",
+            "internals",
+            "is_active"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "collection_components": {
+        "type": "array",
+        "items": {
+          "type": "object",
+          "properties": {
+            "geode_id": {
+              "type": "string",
+              "minLength": 36,
+              "maxLength": 36
+            },
+            "name": {
+              "type": "string"
+            },
+            "type": {
+              "type": "string"
+            },
+            "items": {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "minLength": 36,
+                "maxLength": 36
+              }
+            },
+            "is_active": {
+              "type": "boolean"
+            }
+          },
+          "required": [
+            "geode_id",
+            "name",
+            "type",
+            "items",
+            "is_active"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "geode_id": {
+        "type": "string",
+        "minLength": 36,
+        "maxLength": 36
+      },
+      "crs": {
+        "type": "object",
+        "properties": {
+          "authority": {
+            "type": "string"
+          },
+          "code": {
+            "type": "string"
+          },
+          "name": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "authority",
+          "code",
+          "name"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "required": [
+      "native_file",
+      "id",
+      "name",
+      "viewer_type",
+      "is_viewable",
+      "geode_object_type",
+      "geode_id"
+    ],
+    "additionalProperties": false
+  }
+}

opengeodeweb_back-6.17.0rc3/src/opengeodeweb_back/routes/create/schemas/horizon_stack.py

@@ -0,0 +1,82 @@
+from pathlib import Path
+from opengeodeweb_microservice.schemas import Route, load_schema
+from typing import List, Optional
+from dataclasses_json import DataClassJsonMixin
+from opengeodeweb_microservice.schemas import print_dataclass
+from dataclasses import dataclass
+from typing import List
+
+
+@dataclass
+class HorizonStack(DataClassJsonMixin):
+    def __post_init__(self) -> None:
+        print_dataclass(self)
+
+    horizons: List[str]
+    name: str
+    unit_names: List[str]
+
+
+@dataclass
+class CollectionComponent(DataClassJsonMixin):
+    def __post_init__(self) -> None:
+        print_dataclass(self)
+
+    geode_id: str
+    is_active: bool
+    items: List[str]
+    name: str
+    type: str
+
+
+@dataclass
+class CRS(DataClassJsonMixin):
+    def __post_init__(self) -> None:
+        print_dataclass(self)
+
+    authority: str
+    code: str
+    name: str
+
+
+@dataclass
+class MeshComponent(DataClassJsonMixin):
+    def __post_init__(self) -> None:
+        print_dataclass(self)
+
+    boundaries: List[str]
+    geode_id: str
+    internals: List[str]
+    is_active: bool
+    name: str
+    type: str
+    viewer_id: int
+
+
+@dataclass
+class HorizonStackResponse(DataClassJsonMixin):
+    def __post_init__(self) -> None:
+        print_dataclass(self)
+
+    geode_id: str
+    geode_object_type: str
+    id: str
+    is_viewable: bool
+    name: str
+    native_file: str
+    viewer_type: str
+    binary_light_viewable: Optional[str] = None
+    collection_components: Optional[List[CollectionComponent]] = None
+    crs: Optional[CRS] = None
+    mesh_components: Optional[List[MeshComponent]] = None
+    nb_vertices: Optional[int] = None
+    viewable_file: Optional[str] = None
+
+
+horizon_stack_route = Route(
+    schema=load_schema(Path(__file__)),
+    params=HorizonStack,
+    response=HorizonStackResponse,
+)
+
+__all__ = ["HorizonStack", "HorizonStackResponse", "horizon_stack_route"]

{opengeodeweb_back-6.17.0rc2 → opengeodeweb_back-6.17.0rc3}/src/opengeodeweb_back/routes/schemas/__init__.py

@@ -21,6 +21,7 @@ from .model_component_edge_attribute_range import *
 from .model_component_edge_attribute_names import *
 from .kill import *
 from .import_project import *
+from .horizon_stack_info import *
 from .geode_objects_and_output_extensions import *
 from .geode_object_inheritance import *
 from .export_project import *

opengeodeweb_back-6.17.0rc3/src/opengeodeweb_back/routes/schemas/horizon_stack_info.json

@@ -0,0 +1,70 @@
+{
+  "route": "/horizon_stack_info",
+  "methods": [
+    "POST"
+  ],
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "minLength": 32,
+      "maxLength": 32
+    }
+  },
+  "required": [
+    "id"
+  ],
+  "additionalProperties": false,
+  "response": {
+    "type": "object",
+    "properties": {
+      "horizons": {
+        "type": "array",
+        "items": {
+          "type": "object",
+          "properties": {
+            "id": {
+              "type": "string",
+              "minLength": 36,
+              "maxLength": 36
+            },
+            "name": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "id",
+            "name"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "units": {
+        "type": "array",
+        "items": {
+          "type": "object",
+          "properties": {
+            "id": {
+              "type": "string",
+              "minLength": 36,
+              "maxLength": 36
+            },
+            "name": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "id",
+            "name"
+          ],
+          "additionalProperties": false
+        }
+      }
+    },
+    "required": [
+      "horizons",
+      "units"
+    ],
+    "additionalProperties": false
+  }
+}

opengeodeweb_back-6.17.0rc3/src/opengeodeweb_back/routes/schemas/horizon_stack_info.py

@@ -0,0 +1,50 @@
+from pathlib import Path
+from opengeodeweb_microservice.schemas import Route, load_schema
+from typing import List
+from dataclasses_json import DataClassJsonMixin
+from opengeodeweb_microservice.schemas import print_dataclass
+from dataclasses import dataclass
+
+
+@dataclass
+class HorizonStackInfo(DataClassJsonMixin):
+    def __post_init__(self) -> None:
+        print_dataclass(self)
+
+    id: str
+
+
+@dataclass
+class Horizon(DataClassJsonMixin):
+    def __post_init__(self) -> None:
+        print_dataclass(self)
+
+    id: str
+    name: str
+
+
+@dataclass
+class Unit(DataClassJsonMixin):
+    def __post_init__(self) -> None:
+        print_dataclass(self)
+
+    id: str
+    name: str
+
+
+@dataclass
+class HorizonStackInfoResponse(DataClassJsonMixin):
+    def __post_init__(self) -> None:
+        print_dataclass(self)
+
+    horizons: List[Horizon]
+    units: List[Unit]
+
+
+horizon_stack_info_route = Route(
+    schema=load_schema(Path(__file__)),
+    params=HorizonStackInfo,
+    response=HorizonStackInfoResponse,
+)
+
+__all__ = ["HorizonStackInfo", "HorizonStackInfoResponse", "horizon_stack_info_route"]

{opengeodeweb_back-6.17.0rc2 → opengeodeweb_back-6.17.0rc3}/tests/test_create_routes.py

@@ -152,3 +152,75 @@ def test_create_polygonal_surface(client: FlaskClient, surface_data: test_utils.
 
     # Test with missing parameters
     test_utils.test_route_wrong_params(client, route, lambda: copy.deepcopy(surface_data))
+
+
+@pytest.fixture
+def horizon_stack_data() -> test_utils.JsonData:
+    return {
+        "name": "test_horizon_stack",
+        "horizons": ["Top", "Middle", "Bottom"],
+        "unit_names": ["Above", "Upper", "Lower", "Below"],
+    }
+
+
+def test_create_horizon_stack(client: FlaskClient, horizon_stack_data: test_utils.JsonData) -> None:
+    """Test the creation of a horizon stack from scratch, then read it back top to bottom."""
+    route: str = "/opengeodeweb_back/create/horizon_stack"
+
+    response = client.post(route, json=horizon_stack_data)
+    assert response.status_code == 200
+
+    response_data = response.get_json()
+    assert response_data["name"] == horizon_stack_data["name"]
+    assert response_data["geode_object_type"] == "HorizonStack3D"
+    assert response_data["is_viewable"] is False
+
+    info = client.post("/opengeodeweb_back/horizon_stack_info", json={"id": response_data["id"]})
+    assert info.status_code == 200
+    info_data = info.get_json()
+    assert [horizon["name"] for horizon in info_data["horizons"]] == horizon_stack_data["horizons"]
+    assert [unit["name"] for unit in info_data["units"]] == horizon_stack_data["unit_names"]
+
+    test_utils.test_route_wrong_params(client, route, lambda: copy.deepcopy(horizon_stack_data))
+
+
+def test_create_horizon_stack_without_unit_names(client: FlaskClient) -> None:
+    """Unit names are optional: an empty list creates unnamed units."""
+    route: str = "/opengeodeweb_back/create/horizon_stack"
+    response = client.post(route, json={"name": "stack", "horizons": ["H1"], "unit_names": []})
+    assert response.status_code == 200
+
+    info = client.post(
+        "/opengeodeweb_back/horizon_stack_info", json={"id": response.get_json()["id"]}
+    )
+    assert info.status_code == 200
+    assert len(info.get_json()["units"]) == 2
+
+
+def test_create_horizon_stack_wrong_unit_count(client: FlaskClient) -> None:
+    """There must be one more unit than horizons."""
+    route: str = "/opengeodeweb_back/create/horizon_stack"
+    response = client.post(
+        route, json={"name": "stack", "horizons": ["H1", "H2"], "unit_names": ["U1", "U2"]}
+    )
+    assert response.status_code == 400
+
+
+def test_create_horizon_stack_duplicate_horizons(client: FlaskClient) -> None:
+    """Horizon names must be unique."""
+    route: str = "/opengeodeweb_back/create/horizon_stack"
+    response = client.post(
+        route, json={"name": "stack", "horizons": ["H1", "H1"], "unit_names": []}
+    )
+    assert response.status_code == 400
+
+
+def test_horizon_stack_info_wrong_type(
+    client: FlaskClient, point_data: test_utils.JsonData
+) -> None:
+    """Reading the horizon stack of another object is a client error."""
+    point_set = client.post("/opengeodeweb_back/create/point_set", json=point_data)
+    info = client.post(
+        "/opengeodeweb_back/horizon_stack_info", json={"id": point_set.get_json()["id"]}
+    )
+    assert info.status_code == 400