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.

Files for up42-py, version 0.11.0
Filename, size File type Python version Upload date Hashes
Filename, size up42_py-0.11.0-py3-none-any.whl (43.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size up42-py-0.11.0.tar.gz (36.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page