evo-blockmodels 0.0.1__tar.gz

evo_blockmodels-0.0.1/.gitignore

@@ -0,0 +1,24 @@
+# IDE Settings
+.idea/
+.project
+.pydevproject
+.vscode/
+
+# Distribution / Packaging
+*.egg*
+*.whl
+__pycache__/
+site/
+build/
+
+# Reporting
+.coverage
+
+# Environmnents
+venv/
+venv*/
+.venv/
+.env
+.tox/
+
+.DS_store

evo_blockmodels-0.0.1/LICENSE.md

@@ -0,0 +1,190 @@
+   Copyright © 2025 Bentley Systems, Incorporated.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

evo_blockmodels-0.0.1/PKG-INFO

@@ -0,0 +1,93 @@
+Metadata-Version: 2.4
+Name: evo-blockmodels
+Version: 0.0.1
+Summary: Python SDK for using the Seequent Evo Geoscience Block Model API
+Project-URL: Source, https://github.com/SeequentEvo/evo-python-sdk
+Project-URL: Tracker, https://github.com/SeequentEvo/evo-python-sdk/issues
+Project-URL: Homepage, https://www.seequent.com/
+Project-URL: Documentation, https://developer.seequent.com/
+Author-email: Seequent <support@seequent.com>
+License-File: LICENSE.md
+Requires-Python: >=3.10
+Requires-Dist: evo-sdk-common>=0.1.0
+Requires-Dist: pydantic<3,>=2
+Provides-Extra: aiohttp
+Requires-Dist: evo-sdk-common[aiohttp]>=0.1.0; extra == 'aiohttp'
+Provides-Extra: notebooks
+Requires-Dist: evo-sdk-common[notebooks]>=0.1.0; extra == 'notebooks'
+Provides-Extra: pyarrow
+Requires-Dist: pyarrow>=19.0.0; extra == 'pyarrow'
+Description-Content-Type: text/markdown
+
+<p align="center"><a href="https://seequent.com" target="_blank"><picture><source media="(prefers-color-scheme: dark)" srcset="https://developer.seequent.com/img/seequent-logo-dark.svg" alt="Seequent logo" width="400" /><img src="https://developer.seequent.com/img/seequent-logo.svg" alt="Seequent logo" width="400" /></picture></a></p>
+<p align="center">
+    <a href="https://pypi.org/project/evo-blockmodels/"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/evo-blockmodels" /></a>
+    <a href="https://github.com/SeequentEvo/evo-python-sdk/actions/workflows/run-all-tests.yaml"><img src="https://github.com/SeequentEvo/evo-python-sdk/actions/workflows/run-all-tests.yaml/badge.svg" alt="" /></a>
+</p>
+<p align="center">
+    <a href="https://developer.seequent.com/" target="_blank">Seequent Developer Portal</a>
+    &bull; <a href="https://community.seequent.com/group/19-evo" target="_blank">Seequent Community</a>
+    &bull; <a href="https://seequent.com" target="_blank">Seequent website</a>
+</p>
+
+# Evo Block Model API Client
+
+The Block Model API provides the ability to manage and report on block models in your Evo workspaces. Enable your
+product with Evo connected workflows by integrating with the Seequent Block Model API.
+
+The Block Model API supports a range of sub-blocking options, and both full and partial updates to block models,
+including updates of specified columns and/or sub-volumes. Block models are versioned, and the service supports
+reporting on the material content of current or previous versions, and comparing the content between versions of
+a block model.
+
+## Pre-requisites
+
+* Python ^3.10
+* An [application registered in Bentley](https://developer.bentley.com/register/?product=seequent-evo)
+
+## Installation
+
+```shell
+pip install evo-blockmodels
+```
+
+## Usage
+
+See [the evo-sdk-common documentation](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-sdk-common/README.md)
+for information on how to authenticate, then select the organisation, hub and workspace that you would like to use.
+
+### Interacting with the Geoscience Block Model API
+
+To get up and running quickly with the Evo Block Models SDK, start by configuring your
+[environment and API connector](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-sdk-common/docs/quickstart.md).
+
+```python
+from evo.blockmodels import BlockModelAPIClient
+
+service_client = BlockModelAPIClient(environment, connector)
+service_health = await service_client.get_service_health()
+service_health.raise_for_status()
+```
+
+For some interactive Jupyter notebook examples, see the [examples folder](https://github.com/SeequentEvo/evo-python-sdk/tree/main/packages/evo-blockmodels/docs/examples).
+
+## Contributing
+
+For instructions on contributing to the development of this library, please refer to the [evo-python-sdk documentation](https://github.com/seequentevo/evo-python-sdk).
+
+## License
+
+The Python SDK for Evo is open source and licensed under the [Apache 2.0 license.](https://github.com/SeequentEvo/evo-python-sdk/tree/main/packages/evo-blockmodels/./LICENSE.md).
+
+Copyright © 2025 Bentley Systems, Incorporated.
+
+Licensed under the Apache License, Version 2.0 (the "License").
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

evo_blockmodels-0.0.1/pyproject.toml

@@ -0,0 +1,74 @@
+[project]
+name = "evo-blockmodels"
+description = "Python SDK for using the Seequent Evo Geoscience Block Model API"
+version = "0.0.1"
+requires-python = ">=3.10"
+license-files = ["LICENSE.md"]
+dynamic = ["readme"]
+authors = [
+    { name = "Seequent", email = "support@seequent.com" }
+]
+
+dependencies = [
+    "evo-sdk-common>=0.1.0",
+    "pydantic>=2,<3",
+]
+
+[project.urls]
+Source = "https://github.com/SeequentEvo/evo-python-sdk"
+Tracker = "https://github.com/SeequentEvo/evo-python-sdk/issues"
+Homepage = "https://www.seequent.com/"
+Documentation = "https://developer.seequent.com/"
+
+[project.optional-dependencies]
+pyarrow = ["pyarrow>=19.0.0"]
+aiohttp = ["evo-sdk-common[aiohttp]>=0.1.0"]
+notebooks = ["evo-sdk-common[notebooks]>=0.1.0"]
+
+[dependency-groups]
+# Dev dependencies. The version is left unspecified so the latest is installed.
+test = [
+    "evo-blockmodels[aiohttp,pyarrow]",
+    "parameterized==0.9.0",
+    "pytest",
+]
+dev = [
+    "evo-blockmodels[notebooks]",
+    "bumpver",
+    "coverage[toml]",
+    "ruff",
+    {include-group = "test"}
+]
+notebooks = [
+    "evo-blockmodels[aiohttp,notebooks,pyarrow]",
+    "jupyter",
+]
+
+[tool.ruff]
+src = ["src", "tests"]
+line-length = 120
+
+[tool.ruff.lint]
+extend-select = ["I", "RUF022"]
+
+[build-system]
+requires = ["hatchling", "hatch-fancy-pypi-readme"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.sdist]
+include = ["/src"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/evo"]
+
+[tool.hatch.metadata.hooks.fancy-pypi-readme]
+content-type = "text/markdown"
+
+[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
+path = "README.md"
+
+[[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]]
+# Literal TOML strings (single quotes) need no escaping of backslashes.
+# Converts relative links to absolute links in PyPI
+pattern = '\[(.+?)\]\(((?!https?://)\S+?)\)'
+replacement = '[\1](https://github.com/SeequentEvo/evo-python-sdk/tree/main/packages/$HFPR_PACKAGE_NAME/\g<2>)'

evo_blockmodels-0.0.1/src/evo/blockmodels/__init__.py

@@ -0,0 +1,16 @@
+#  Copyright © 2025 Bentley Systems, Incorporated
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#      http://www.apache.org/licenses/LICENSE-2.0
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+from .client import BlockModelAPIClient
+
+__all__ = [
+    "BlockModelAPIClient",
+]

evo_blockmodels-0.0.1/src/evo/blockmodels/_model_config.py

@@ -0,0 +1,21 @@
+#  Copyright © 2025 Bentley Systems, Incorporated
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#      http://www.apache.org/licenses/LICENSE-2.0
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+from pydantic import BaseModel, ConfigDict
+
+
+class CustomBaseModel(BaseModel):
+    """Custom base model for providing a global configuration to generated models."""
+
+    model_config = ConfigDict(
+        extra="allow",
+        protected_namespaces=(),
+    )

evo_blockmodels-0.0.1/src/evo/blockmodels/_types.py

@@ -0,0 +1,82 @@
+#  Copyright © 2025 Bentley Systems, Incorporated
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#      http://www.apache.org/licenses/LICENSE-2.0
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+from __future__ import annotations
+
+from typing import Protocol
+
+# `evo-blockmodels` uses protocols for annotating some pyarrow types, because:
+# - pyarrow is optional, but type annotations are not.
+# - pyarrow has poor type checker support.
+#
+# These protocols should be treated as aliases for the corresponding pyarrow types.
+# Any required interfaces from the corresponding pyarrow types should be added to these protocols as needed.
+
+
+class DataType(Protocol):
+    """Pyarrow data type.
+
+    https://arrow.apache.org/docs/python/generated/pyarrow.DataType.html
+    """
+
+    ...
+
+
+class Schema(Protocol):
+    """Pyarrow schema.
+
+    https://arrow.apache.org/docs/python/generated/pyarrow.Schema.html
+    """
+
+    @property
+    def names(self) -> list[str]:
+        """The schema's field names."""
+        ...
+
+    @property
+    def types(self) -> list[DataType]:
+        """The schema's field types."""
+        ...
+
+
+class Table(Protocol):
+    """Pyarrow table.
+
+    https://arrow.apache.org/docs/python/generated/pyarrow.Table.html
+    """
+
+    @property
+    def schema(self) -> Schema:
+        """Schema of the table and its columns."""
+        ...
+
+    @property
+    def num_columns(self) -> int:
+        """Number of columns in this table."""
+        ...
+
+    @property
+    def num_rows(self) -> int:
+        """Number of rows in this table.
+
+        Due to the definition of a table, all columns have the same number of rows.
+        """
+        ...
+
+    def to_pandas(self) -> DataFrame:
+        """Convert to a pandas-compatible NumPy array or DataFrame, as appropriate"""
+
+
+class DataFrame(Protocol):
+    """Pandas DataFrame.
+
+    https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html
+    """

evo_blockmodels-0.0.1/src/evo/blockmodels/_utils.py

@@ -0,0 +1,63 @@
+#  Copyright © 2025 Bentley Systems, Incorporated
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#      http://www.apache.org/licenses/LICENSE-2.0
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+from __future__ import annotations
+
+from typing import TypeVar
+from uuid import UUID
+
+from ._types import DataType
+from .endpoints import models
+from .endpoints.models import JobResponse
+from .exceptions import UnknownJobPayload
+
+T = TypeVar("T")
+
+
+def extract_payload(job_id: UUID, job_response: JobResponse, payload_type: type[T]) -> T:
+    payload = job_response.payload
+    if isinstance(payload, payload_type):
+        return payload
+    else:
+        raise UnknownJobPayload(
+            job_id, f"Expected {payload_type.__name__} for job payload, got {type(payload).__name__} instead"
+        )
+
+
+try:
+    import pyarrow
+except ImportError:
+    data_type_mapping = {}
+else:
+    data_type_mapping = {
+        pyarrow.bool_(): models.DataType.Boolean,
+        pyarrow.int8(): models.DataType.Int8,
+        pyarrow.int16(): models.DataType.Int16,
+        pyarrow.int32(): models.DataType.Int32,
+        pyarrow.int64(): models.DataType.Int64,
+        pyarrow.uint8(): models.DataType.UInt8,
+        pyarrow.uint16(): models.DataType.UInt16,
+        pyarrow.uint32(): models.DataType.UInt32,
+        pyarrow.uint64(): models.DataType.UInt64,
+        pyarrow.float16(): models.DataType.Float16,
+        pyarrow.float32(): models.DataType.Float32,
+        pyarrow.float64(): models.DataType.Float64,
+        pyarrow.utf8(): models.DataType.Utf8,
+        pyarrow.date32(): models.DataType.Date32,
+        pyarrow.timestamp("us", tz="UTC"): models.DataType.Timestamp,
+    }
+
+
+def convert_dtype(data_type: DataType) -> models.DataType:
+    try:
+        return data_type_mapping[data_type]
+    except KeyError:
+        raise ValueError(f"Unsupported data type: {data_type}")