Skip to main content

Python SDK for UP42

Project description

Python SDK for UP42, the geospatial marketplace and developer platform.

Documentation   •   UP42.com   •   Support

Highlights

  • Python package for easy access to UP42's geospatial datasets & processing workflows
  • Use UP42 functionality together with your preffered Python libraries!
  • For geospatial analysis & product builders!
  • Interactive maps & visualization, ideal with Jupyter notebooks
  • Command Line Interface (CLI)

Installation & Documentation

See the documentation for getting started guides, examples and the code reference.

The package requires Python > 3.6.

pip install up42-py

30-second Example

The UP42 Python package uses six classes, representing the hierarchical structure of UP42: Project > Workflow > Job > JobTask and Catalog & Tools

A new workflow consisting of Sentinel-2 data and Image Sharpening is created. The area of interest and workflow parameters are defined. After running the job, the results are downloaded and visualized.

Try this example without installation! Binder

import up42
up42.authenticate(project_id="12345", project_api_key="12345")
# up42.authenticate(cfg_file="config.json")

project = up42.initialize_project()
workflow = project.create_workflow(name="30-seconds-workflow", use_existing=True)

# Add data and processing blocks to the workflow.
print(up42.get_blocks(basic=True))
input_tasks = ['sobloo-s2-l1c-aoiclipped', 'sharpening']
workflow.add_workflow_tasks(input_tasks=input_tasks)

# Define the aoi and input parameters of the workflow.
aoi = workflow.get_example_aoi(as_dataframe=True)
#aoi = workflow.read_vector_file("data/aoi_berlin.geojson", as_dataframe=True)
input_parameters = workflow.construct_parameters(geometry=aoi, 
                                                 geometry_operation="bbox", 
                                                 start_date="2018-01-01",
                                                 end_date="2020-12-31",
                                                 limit=1)
input_parameters["sobloo-s2-l1c-aoiclipped:1"].update({"max_cloud_cover":60})

# Run a test job to check data availability and configuration.
test_job = workflow.test_job(input_parameters=input_parameters, track_status=True)
test_results = test_job.get_results_json()
print(test_results)

# Run the actual job.
job = workflow.run_job(input_parameters=input_parameters, track_status=True)

job.download_results()
job.plot_results()

Support

For any kind of issues or suggestions please see the documentation, open a github issue or contact us via Email support@up42.com

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

up42-py-0.11.0.tar.gz (36.4 kB view details)

Uploaded Source

Built Distribution

up42_py-0.11.0-py3-none-any.whl (43.8 kB view details)

Uploaded Python 3

File details

Details for the file up42-py-0.11.0.tar.gz.

File metadata

  • Download URL: up42-py-0.11.0.tar.gz
  • Upload date:
  • Size: 36.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.7.7

File hashes

Hashes for up42-py-0.11.0.tar.gz
Algorithm Hash digest
SHA256 f1ef444132c84e68c2763c6c1a12f22daf3fca92ddedded4d34dae61f12ae2d9
MD5 a0cf72fadec623b0675ead8a8d19f985
BLAKE2b-256 85c52149e603227d9cddf45636c20f84ef05d1d98acecc360e4de8cfc9de6e8e

See more details on using hashes here.

File details

Details for the file up42_py-0.11.0-py3-none-any.whl.

File metadata

  • Download URL: up42_py-0.11.0-py3-none-any.whl
  • Upload date:
  • Size: 43.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.7.7

File hashes

Hashes for up42_py-0.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 516e403ca0f59a395b2c2993b3fc3479c2250a54d03cbdfac9f4236c23ddc014
MD5 ecdd642b11a0535e17c86b97625529c7
BLAKE2b-256 e811eb8d952dabbda9437421f048321ec03910b67cabf15e0c24f4f8f843b6ce

See more details on using hashes here.

Supported by

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