evo-data-converters-omf 0.1.0__tar.gz

evo_data_converters_omf-0.1.0/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_data_converters_omf-0.1.0/PKG-INFO

@@ -0,0 +1,261 @@
+Metadata-Version: 2.4
+Name: evo-data-converters-omf
+Version: 0.1.0
+Summary: Python data converters for OMF to Evo geoscience objects
+Author-email: Seequent <support@seequent.com>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: evo-data-converters-common
+Requires-Dist: pandas
+Requires-Dist: omf>=1.0.1
+Requires-Dist: omf2>=0.2.0-beta.1
+Dynamic: license-file
+
+<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-data-converters-omf/"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/evo-data-converters-omf" /></a>
+    <a href="https://github.com/SeequentEvo/evo-data-converters/actions/workflows/on-merge.yaml"><img src="https://github.com/SeequentEvo/evo-data-converters/actions/workflows/on-merge.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/" target="_blank">Seequent Community</a>
+    &bull; <a href="https://seequent.com" target="_blank">Seequent website</a>
+</p>
+
+## Evo
+
+Evo is a unified platform for geoscience teams. It enables access, connection, computation, and management of subsurface data. This empowers better decision-making, simplified collaboration, and accelerated innovation. Evo is built on open APIs, allowing developers to build custom integrations and applications. Our open schemas, code examples, and SDK are available for the community to use and extend. 
+
+Evo is powered by Seequent, a Bentley organisation.
+
+## Pre-requisites
+
+* Python >= 3.10, <= 3.12
+
+## Installation
+
+**Note:** This project depends on `omf2`, which is not available in PyPI yet. You must install it from source before you can use this project.
+
+```
+pip install -e "git+https://github.com/gmggroup/omf-rust.git#egg=omf2&subdirectory=omf-python"
+
+pip install evo-data-converters
+```
+
+## OMF
+
+Open Mining Format (OMF) is a standard backed by the Global Mining Guidelines Group.
+
+Refer here for more information: https://omf.readthedocs.io/en/latest/
+
+To work with OMF files the `omf2` module is used, which is a Python interface to the `omf_rust` package:
+
+https://github.com/gmggroup/omf-rust
+
+### Publish geoscience objects from an OMF file
+**Note**: For some OMF geometry types there is more than one possible way they could be converted to geoscience objects. For example, an OMF `LineSet` can be used to represent more than one thing (poly-lines, drillholes, a wireframe mesh, etc). In this example they are converted to `LineSegments`. Depending on your use case, you may want to convert them to a different geoscience object.
+
+[The `evo-sdk-common` Python library](https://pypi.org/project/evo-sdk-common/) can be used to sign in. After successfully signing in, the user can select an organisation, an Evo hub, and a workspace. Use [`evo-objects`](https://pypi.org/project/evo-objects/) to get an `ObjectAPIClient`, and [`evo-data-converters-common`](https://pypi.org/project/evo-data-converters-common/) to convert your file.
+
+Choose the OMF file you want to publish and set its path in the `omf_file` variable.
+Choose an EPSG code to use for the Coordinate Reference System.
+
+You can also specify tags to add to the created geoscience objects.
+
+Then call `convert_omf`, passing it the OMF file path, EPSG code, the `ObjectAPIClient` from above, and finally a path you want the published objects to appear under in your workspace.
+
+**Note:** Some geometry types are not yet supported. A warning will be shown for each element that could not be converted.
+
+```python
+import os
+import pprint
+
+from evo.aio import AioTransport
+from evo.common import APIConnector
+from evo.common.utils import BackoffIncremental
+from evo.data_converters.omf.importer import convert_omf
+from evo.discovery import DiscoveryAPIClient
+from evo.oauth import AuthorizationCodeAuthorizer, OIDCConnector
+from evo.objects import ObjectAPIClient
+from evo.workspaces import WorkspaceAPIClient
+
+# Configure the transport.
+transport = AioTransport(
+    user_agent="evo-sdk-common-example",
+    max_attempts=3,
+    backoff_method=BackoffIncremental(2),
+    num_pools=4,
+    verify_ssl=True,
+)
+
+# Login to the Evo platform.
+# User Login
+authorizer = AuthorizationCodeAuthorizer(
+    redirect_url="<redirect_url>",
+    oidc_connector=OIDCConnector(
+        transport=transport,
+        oidc_issuer="<issuer_url>",
+        client_id="<client_id>",
+    ),
+)
+await authorizer.login()
+
+# Select an Organization.
+async with APIConnector("https://discover.api.seequent.com", transport, authorizer) as api_connector:
+    discovery_client = DiscoveryAPIClient(api_connector)
+    organizations = await discovery_client.list_organizations()
+
+selected_org = organizations[0]
+
+# Select a hub and create a connector.
+hub_connector = APIConnector(selected_org.hubs[0].url, transport, authorizer)
+
+# Select a Workspace.
+async with hub_connector:
+    workspace_client = WorkspaceAPIClient(hub_connector, selected_org.id)
+    workspaces = await workspace_client.list_workspaces()
+
+workspace = workspaces[0]
+workspace_env = workspace.get_environment()
+
+# Convert your object.
+async with hub_connector:
+    service_client = ObjectAPIClient(workspace_env, hub_connector)
+    omf_file = os.path.join(os.getcwd(), "data/input/one_of_everything.omf")
+    epsg_code = 32650
+
+    tags = {"TagName": "Tag value"}
+
+    objects_metadata = convert_omf(
+        filepath=omf_file,
+        epsg_code=epsg_code,
+        object_service_client=service_client,
+        tags=tags,
+        upload_path="path/to/my/object"
+    )
+
+    print("These objects have now been published:")
+    for metadata in objects_metadata:
+        pprint.pp(metadata, indent=4)
+```
+
+### Export objects to OMF
+
+To export an object from Evo to an OMF file, specify the Evo object UUID of the object you want to export and the output file path, and then call `export_omf()`.
+See documentation on the `ObjectAPIClient` for listing objects and getting their IDs and versions.
+
+You may also specify the version of this object to export. If not specified, so it will export the latest version.
+
+You will need the same selection of organisation, Evo hub, and workspace that is needed for importing objects.
+
+**Note**: Some geoscience object types are not yet supported.
+
+```python
+import os
+from uuid import UUID
+
+from evo.data_converters.common import EvoObjectMetadata
+from evo.data_converters.omf.exporter import export_omf
+
+objects = []
+objects.append(
+    EvoObjectMetadata(
+        object_id=UUID("<object_id>"),
+        version_id="<version_id>"))
+
+output_dir = "data/output"
+os.makedirs(output_dir, exist_ok=True)
+
+output_file = f"{output_dir}/object.omf"
+
+export_omf(
+    filepath=output_file,
+    objects=objects,
+    service_client=service_client,
+)
+```
+
+### Block models
+
+[Block models](https://developer.seequent.com/docs/guides/blockmodel) can be imported using the standard `convert_omf` function.
+
+Block models work a little bit differently for export. These use a `BlockSyncClient` rather than the `ObjectAPIClient` to access models stored in BlockSync. Create a `BlockSyncClient` using the Environment and APIConnector in the same way you would create and `ObjectAPIClient`.
+
+```python
+from evo.data_converters.common import BlockSyncClient
+
+blocksync_client = BlockSyncClient(workspace_env, hub_connector)
+```
+
+#### Export a block model to OMF V1
+
+Specify the block model UUID of the block model object you want to export and the output file path, then call `export_blocksync_omf()`.
+
+**Note**: At this stage only Regular block model types are supported.
+
+```python
+import os
+from uuid import UUID
+
+from evo.data_converters.omf.exporter import export_blocksync_omf
+
+object_id = ""
+version_id = None
+
+output_dir = "data/output"
+os.makedirs(output_dir, exist_ok=True)
+
+output_file = f"{output_dir}/{object_id}.omf"
+
+export_blocksync_omf(
+    filepath=output_file,
+    object_id=UUID(object_id),
+    version_id=version_id,
+    service_client=blocksync_client,
+)
+
+print(f"File saved to {output_file}")
+```
+
+### Download Parquet file only
+
+```python
+import shutil
+
+import pyarrow.parquet as pq
+
+object_id = ""
+dest_file = f"data/output/{object_id}.parquet"
+
+job_url = blocksync_client.get_blockmodel_columns_job_url(object_id)
+download_url = blocksync_client.get_blockmodel_columns_download_url(job_url)
+downloaded_file = blocksync_client.download_parquet(download_url)
+
+shutil.copy(downloaded_file.name, dest_file)
+
+table = pq.read_table(dest_file)
+
+for column in table.column_names:
+    print(f"{column} is of type: {table.schema.field(column).type}")
+```
+
+## Code of conduct
+
+We rely on an open, friendly, inclusive environment. To help us ensure this remains possible, please familiarise yourself with our [code of conduct.](https://github.com/SeequentEvo/evo-data-converters/blob/main/CODE_OF_CONDUCT.md)
+
+## License
+Evo data converters are open source and licensed under the [Apache 2.0 license.](./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.