Skip to content

Python SDK for seamless Evo API integration and manipulation of geoscience data.

License

Notifications You must be signed in to change notification settings

Bill-Johnson-Seequent/evo-python-sdk

 
 

Seequent logo

Seequent Developer PortalSeequent CommunitySeequent website

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.

SDKs

This repository contains a number of sub-packages. You may choose to install the evo-sdk package, which includes all sub-packages and optional dependencies (e.g. Jupyter notebook support), or choose a specific package to install:

Package Version Description
evo-sdk PyPI - Version A metapackage that installs all available Seequent Evo SDKs, including Jupyter notebook examples.
evo-sdk-common PyPI - Version A shared library that provides common functionality for integrating with Seequent's client SDKs.
evo-files PyPI - Version A service client for interacting with the Evo File API.
evo-objects PyPI - Version A geoscience object service client library designed to help get up and running with the Geoscience Object API.
evo-colormaps PyPI - Version A service client to create colour mappings and associate them to geoscience data with the Colormap API.
evo-blockmodels PyPI - Version The Block Model API provides the ability to manage and report on block models in your Evo workspaces.

Pre-requisites

Installation

To install the evo-sdk package, including all sub-packages, run the following command:

pip install evo-sdk

Seequent Evo APIs use OAuth for authentication. In order to support it in this example, we'll be using the asyncio library to power the OAuth callback process.

pip install asyncio

Getting started

Now that you have installed the Evo SDK, you can get started by configuring your API connector, and performing a basic API call to list the organizations that you have access to:

from evo.aio import AioTransport
from evo.oauth import OAuthConnector, AuthorizationCodeAuthorizer
from evo.discovery import DiscoveryAPIClient
from evo.common import APIConnector
import asyncio

transport = AioTransport(user_agent="Your Application Name")
connector = OAuthConnector(transport=transport, client_id="<YOUR_CLIENT_ID>")
authorizer = AuthorizationCodeAuthorizer(oauth_connector=connector, redirect_url="http://localhost:3000/signin-callback")

async def main():
    await authorizer.login()
    await discovery()

async def discovery():
    async with APIConnector("https://discover.api.seequent.com", transport, authorizer) as api_connector:
        discovery_client = DiscoveryAPIClient(api_connector)
        organizations = await discovery_client.list_organizations()
        print("Organizations:", organizations)

asyncio.run(main())

For next steps and more information about using Evo, see:

Contributing

Thank you for your interest in contributing to Seequent software. Please have a look over our contribution guide.

Getting started

All Python SDKs in this monorepo are managed with uv. We use workspaces in order to manage the different SDKs published out of this repository.

With workspaces, uv lock operates on the entire workspace at once. uv run and uv sync operate on the workspace root by default, though both accept a --package argument allowing you to run a command in a particular workspace member from any workspace directory.

Install UV

To install UV on your machine, run one of the following convenience scripts from the root of the repo. These scripts ensure everyone is using the same version.

Windows:

./scripts/install-uv.ps1

UNIX-like:

./scripts/install-uv.sh

You can run the same script again whenever the version in the UV_VERSION file changes. It will replace your existing installation of UV.

Install pre-commit hooks

Once you've installed UV, install pre-commit hooks. These are used to standardise development workflows for all contributors:

uv run pre-commit install

Setting up and running Jupyter notebooks

Notebooks can be run in your tool of choice (e.g. VS Code). To use Jupyter (the default):

uv sync --all-packages --all-extras

Then, in the directory of the notebook(s) you want to run:

uv run jupyter notebook

A browser should launch where you can open the notebooks for the current directory.

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.

License

The Python SDK for Evo is open source and licensed under the Apache 2.0 license..

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.

About

Python SDK for seamless Evo API integration and manipulation of geoscience data.

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 94.6%
  • Jupyter Notebook 5.1%
  • Other 0.3%