You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+40-24Lines changed: 40 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,43 @@ Evo is a unified platform for geoscience teams. It enables access, connection, c
14
14
15
15
Evo is powered by Seequent, a Bentley organisation.
16
16
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
18
54
19
55
This repository contains a number of sub-packages. You may choose to install the `evo-sdk` package, which includes all
20
56
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
29
65
|[evo-blockmodels](packages/evo-blockmodels/README.md)| <ahref="https://pypi.org/project/evo-blockmodels/"><imgalt="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. |
30
66
|[evo-compute](packages/evo-compute/README.md)| <ahref="https://pypi.org/project/evo-compute/"><imgalt="PyPI - Version"src="https://img.shields.io/pypi/v/evo-compute" /></a> | A service client to send jobs to the Compute Tasks API.|
31
67
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
53
69
54
70
Now that you have installed the Evo SDK, you can get started by configuring your API connector, and performing a
55
71
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
105
121
106
122
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.
0 commit comments