Skip to content

Commit 3b2930f

Browse files
Add evo-samples-internal notebooks
1 parent 9f58f0e commit 3b2930f

103 files changed

Lines changed: 67098 additions & 25 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitignore

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,13 @@ venv*/
2121
.env
2222
.tox/
2323

24-
.DS_store
24+
# Jupyter Notebook checkpoints
25+
.ipynb_checkpoints/
26+
27+
# Sample data directories (ignore all data except input folders)
28+
samples/*/publish*/data/*
29+
samples/*/download*/data/*
30+
!samples/*/publish*/data/input/
31+
32+
# macOS invisible files
33+
.DS_Store

README.md

Lines changed: 40 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,43 @@ Evo is a unified platform for geoscience teams. It enables access, connection, c
1414

1515
Evo is powered by Seequent, a Bentley organisation.
1616

17-
## SDKs
17+
## Prerequisites
18+
19+
Before you get started, make sure you have:
20+
21+
* **A registered Evo app**
22+
23+
*Evo apps* provide the credentials necessary to generate Evo access tokens, which in turn provide access to your Evo data. An app can be created by you or by a member of your team.
24+
25+
Register an Evo app in the [Bentley Developer Portal](https://developer.bentley.com/my-apps). For in-depth instructions, follow this [guide](https://developer.seequent.com/docs/guides/getting-started/apps-and-tokens) on the Seequent Developer Portal.
26+
27+
NOTE: You must have a **Bentley developer account** in order to create apps. If you try to register an app using the link above but find that you don't have permission, contact your account administrator to get access.
28+
29+
* **A local copy of this repository**
30+
31+
Clone the repository using Git or download it as a ZIP file from the green **Code** button at the top of the page.
32+
33+
* **A Python code editor, eg. VS Code, PyCharm**
34+
35+
For running and editing the sample notebooks and other source code files.
36+
37+
## About this repository
38+
39+
`evo-python-sdk` is designed for developers, data scientists, and technical users who want to work with Seequent Evo APIs and geoscience data.
40+
41+
* To quickly learn how to use Evo APIs, start with the [Getting started with Evo samples](#getting-started-with-evo-code-samples) section, which contains practical, end-to-end Jupyter notebook examples for common workflows. Most new users should begin with this section.
42+
43+
* If you are interested in the underlying SDKs or need to understand the implementation details, explore the [Getting started with Evo SDK development](#getting-started-with-evo-sdk-development) section, which contains the source code for each Evo SDK.
44+
45+
* To learn about contributing to this repository, take a look at the [Contributing](#contributing) section.
46+
47+
## Getting started with Evo code samples
48+
49+
For detailed information about creating Evo apps, the authentication setup, available code samples, and step-by-step guides for working with the Jupyter notebooks, please refer to the [**samples/README.md**](samples/README.md) file.
50+
51+
This comprehensive guide will walk you through everything required to get started with Evo APIs.
52+
53+
## Getting started with Evo SDK development
1854

1955
This repository contains a number of sub-packages. You may choose to install the `evo-sdk` package, which includes all
2056
sub-packages and optional dependencies (e.g. Jupyter notebook support), or choose a specific package to install:
@@ -29,27 +65,7 @@ sub-packages and optional dependencies (e.g. Jupyter notebook support), or choos
2965
| [evo-blockmodels](packages/evo-blockmodels/README.md) | <a href="https://pypi.org/project/evo-blockmodels/"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/evo-blockmodels" /></a> | The Block Model API provides the ability to manage and report on block models in your Evo workspaces. |
3066
| [evo-compute](packages/evo-compute/README.md) | <a href="https://pypi.org/project/evo-compute/"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/evo-compute" /></a> | A service client to send jobs to the Compute Tasks API.|
3167

32-
## Pre-requisites
33-
34-
* Python ^3.10
35-
* An [application registered in Bentley](https://developer.bentley.com/register/?product=seequent-evo)
36-
37-
## Installation
38-
39-
To install the `evo-sdk` package, including all sub-packages, run the following command:
40-
41-
```shell
42-
pip install evo-sdk
43-
```
44-
45-
Seequent Evo APIs use OAuth for authentication. In order to support it in this example, we'll be using the
46-
[asyncio library](https://pypi.org/project/asyncio/) to power the OAuth callback process.
47-
48-
```shell
49-
pip install asyncio
50-
```
51-
52-
## Getting started
68+
### Getting started
5369

5470
Now that you have installed the Evo SDK, you can get started by configuring your API connector, and performing a
5571
basic API call to list the organizations that you have access to:
@@ -105,12 +121,12 @@ With workspaces, `uv lock` operates on the entire workspace at once. `uv run` an
105121

106122
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.
107123

108-
Windows:
124+
#### Windows
109125
```shell
110126
./scripts/install-uv.ps1
111127
```
112128

113-
UNIX-like:
129+
#### Linux / macOS
114130
```shell
115131
./scripts/install-uv.sh
116132
```

docs/img/app-callbacks.png

19.2 KB
Loading

docs/img/app-name-native.png

27.8 KB
Loading

docs/img/app-register.png

8.31 KB
Loading

docs/img/create-workspace.png

130 KB
Loading

docs/img/download-zip.png

123 KB
Loading

docs/img/edit-app-native.png

17.5 KB
Loading

docs/img/jupyter-start-here.png

65.7 KB
Loading

docs/img/notebook-auth-setup.png

84.7 KB
Loading

0 commit comments

Comments
 (0)