Skip to content

Installing EarthOne🔗

How to install and setup your EarthOne Python environment🔗

Installing the Python Client🔗

Note: If you are using the Workbench service, you can skip to Authentication.

To start using the EarthOne Platform, you need to install the Python client. Whether you are using a Virtual Machine (VM) or your local machine, you can install the Python client through PyPI:

Authentication🔗

Once you have installed the EarthOne Python API, we must next authenticate your Python client with the Platform and test the connection.

Command Line🔗

Typically this is done via a Terminal in an activated environment, such as Conda, with the following command:

earthone auth login

Python Client🔗

You can also authenticate via the Python SDK:

import earthdaily.earthone
from earthdaily.earthone.core.client.auth.cli import cli

try:
    cli(["login"])
except:
    pass

Environment Variables🔗

If running the EarthOne SDK remotely, you can also pass environment variables, which can be generated at earthone.earthdaily.com/account/refresh-token:

export EARTHONE_CLIENT_ID=...
export EARTHONE_CLIENT_SECRET=...

Note: If you run into trouble with authentication, please feel free to reach out to support@earthdaily.com.

Example Notebooks to get you started🔗

The notebooks are located in our Jupyter Lab environment Workbench. Alternatively, you can visit our GitHub repository to learn how to use the Platform. The repository covers everything from basic concepts and API usage to creating a simple web application that takes advantage of Platform services. To get started, simply clone the repository to your local machine and explore the Jupyter notebooks in the guides/ folder.

git clone https://github.com/earthdaily/earthone-example-notebooks.git

Sample notebooks include examples of working with the API, including modeling, feature annotation, and real-time pipeline orchestration. See the GitHub repo for more information.