Skip to main content

A package for easy access to Geo Engine instances

Project description

Geo Engine Python Package

CI

This package allows easy access to Geo Engine functionality from Python environments.

Test

Create a virtual environment (e.g., python3 -m venv env). Then, install the dependencies with:

python3 -m pip install -e .
python3 -m pip install -e .[test]

Run tests with:

pytest

Dependencies

Since we use cartopy, you need to have the following system dependencies installed.

  • GEOS
  • PROJ

For Ubuntu, you can use this command:

sudo apt-get install libgeos-dev libproj-dev

Build

You can build the package with:

python3 -m pip install -e .[dev]
python3 -m build

Formatting

This packages is formatted according to pycodestyle. You can check it by calling:

python3 -m pycodestyle

Our tip is to install autopep8 and use it to format the code.

Lints

Our CI automatically checks for lint errors. We use pylint to check the code. You can check it by calling:

python3 -m pylint geoengine
python3 -m pylint tests

Our tip is to activate linting with pylint in your IDE.

Documentation

Generate documentation HTML with:

pdoc3 --html --output-dir docs geoengine

Examples

There are several examples in the examples folder. It is necessary to install the dependencies with:

python3 -m pip install -e .[examples]

Distribute to PyPI

Test-PyPI

python3 -m build
python3 -m twine upload --repository testpypi dist/*

PyPI

python3 -m build
python3 -m twine upload --repository pypi dist/*

Try it out

Start a python terminal and try it out:

import geoengine as ge
from datetime import datetime

ge.initialize("https://nightly.peter.geoengine.io/api")

time = datetime.strptime('2014-04-01T12:00:00.000Z', "%Y-%m-%dT%H:%M:%S.%f%z")

workflow = ge.workflow_by_id('4cdf1ffe-cb67-5de2-a1f3-3357ae0112bd')

print(workflow.get_result_descriptor())

workflow.get_dataframe(ge.Bbox([-60.0, 5.0, 61.0, 6.0], [time, time]))

Authentication

If the Geo Engine server requires authentication, you can set your credentials in the following ways:

  1. in the initialize method: ge.initialize("https://nightly.peter.geoengine.io/api", ("email", "password"))
  2. as environment variables export GEOENGINE_EMAIL="email" and export GEOENGINE_PASSWORD="password"
  3. in a .env file in the current working directory with the content:
GEOENGINE_EMAIL="email"
GEOENGINE_PASSWORD="password"

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

geoengine-0.7.0.tar.gz (23.8 kB view hashes)

Uploaded Source

Built Distribution

geoengine-0.7.0-py3-none-any.whl (30.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page