Skip to main content

Fusion Platform® Python SDK

This package contains the Python SDK used to interact with the Fusion Platform®. The Fusion Platform® provides enhanced remote monitoring services. By ingesting remotely sensed Earth Observation (EO) data, and data from other sources, the platform uses and fuses this data to execute algorithms which provide actionable knowledge to customers.

The Python SDK is designed to enable interaction with the Fusion Platform® via its API. As such, the SDK therefore allows software to login, upload files, create and execute processes, monitor their execution and then download the corresponding results. Additional functionality is available directly via the API, and this is defined within the corresponding OpenAPI 3.0 specification, which can be obtained via a support request.

© Digital Content Analysis Technology Ltd

Installation

The SDK has been built for Python 3, and is tested against Python 3.9, 3.10, 3.11, 3.12, 3.13 and 3.14. To install the SDK into a suitable Python environment containing pip, execute the following:

pip install fusion-platform-python-sdk

This will install the SDK and all its dependencies.

To update an existing installation to the latest version, execute the following:

pip install fusion-platform-python-sdk --upgrade

Example

The following shows a simple example of how to use the SDK to create a process, execute it and download the resulting data. This example assumes that a suitable user account has been created with an organisation which has sufficient credits to run the process, and that the SDK has been installed as above. To use a different user account, replace the email address me@org.com and password MyPassword123!.

The example uses a pre-defined region of interest for Glasgow, and then obtains spectral indices for the region. A range of spectral indices are built using ESA's Sentinel-2 multi-spectral data from the most recent date available for Glasgow.

import os
import fusion_platform

# Login with email address and password.
user = fusion_platform.login(email='me@org.com', password='MyPassword123!')

# Select the organisation which will own the file. This is
# the first organisation the user belongs to in this example,
# and which is therefore assumed to have sufficient credits.
organisation = next(user.organisations)

# Create a data item for the Glasgow region of interest:
glasgow = organisation.create_data(name='Glasgow', file_type=fusion_platform.FILE_TYPE_GEOJSON, files=[fusion_platform.EXAMPLE_GLASGOW_FILE], wait=True)

# Find the elevation service.
service, _ = organisation.find_services(keyword='Elevation')

# Create a template process from the service.
process = organisation.new_process(name='Example', service=service)

# Configure the process to use Glasgow as the region.
process.update(input_number=1, data=glasgow)

# Create the process, which will validate its options and inputs.
process.create()

# Before execution, review the price in credits.
print(f"Price: {process.price}")

# Now execute the process and wait for it to complete.
process.execute(wait=True)

# Get the corresponding execution of the process. This is assumed
# to be the most recently started execution.
execution = next(process.executions)

# Now download all the outputs.
for i, component in enumerate(execution.components):
    print(f"Downloading {component.name}")
    component_dir = f"component_{str(i)}"

    for j, output in enumerate(component.outputs):
        dir = os.path.join(component_dir, str(j))
        for file in output.files:
            file.download(path=os.path.join(dir, file.file_name))

# Now tidy everything up by deleting the process and the region.
process.delete()
glasgow.delete()

Documentation

Details of the methods and attributes available from objects used within the SDK can be found https://www.d-cat.co.uk/public/fusion_platform_python_sdk/.

Full documentation can be found in fusion_platform_sdk.pdf.

Support

Support for the SDK can be obtained by contacting Digital Content Analysis Technology Ltd via support@d-cat.co.uk.

License

See LICENSE.txt.

Metadata

Release files for fusion-platform-python-sdk 2.2.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for fusion-platform-python-sdk 2.2.5
File Size Uploaded
fusion_platform_python_sdk-2.2.5.tar.gz 1.4 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for fusion-platform-python-sdk 2.2.5
File Interpreter ABI Platform
fusion_platform_python_sdk-2.2.5-py3-none-any.whl Python 3 none any Details

Total release size: 2.9 MB

Release files / fusion_platform_python_sdk-2.2.5.tar.gz

Download URL fusion_platform_python_sdk-2.2.5.tar.gz
Size 1.4 MB
Tags Source
SHA-256 checksum
How to use checksums
540f65d1766489582d8de7f0f855e88fee0ca334b5c086cb947043b8763e5024
BLAKE2b-256 checksum
How to use checksums
ff8232af407c4a8198ef96128b712b28cf02ffb652db5f1bb30e7631dc3cfc19
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.4

Release files / fusion_platform_python_sdk-2.2.5-py3-none-any.whl

Download URL fusion_platform_python_sdk-2.2.5-py3-none-any.whl
Size 1.5 MB
Tags Python 3
SHA-256 checksum
How to use checksums
b7b7f9cc16e10af97a153011373aee3e741eba97df1bd60aec02b615ec395dd5
BLAKE2b-256 checksum
How to use checksums
c87dff267ff6218220a475ab300488f0d0c8b5a852f616ca677ffd8f19c99e81
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.4

Release history Release notifications | RSS feed

This release

2.2.5 This release

2 release files

2.2.3

2 release files

2.2.2

2 release files

2.2.1

2 release files

2.1.2

2 release files

2.1.1

2 release files

2.0.8

2 release files

2.0.7

2 release files

1.18.3

2 release files

1.17.9

2 release files

1.17.5

2 release files

1.16.6

2 release files

1.14.7

2 release files

1.14.6

2 release files

1.13.1

2 release files

1.12.2

2 release files

1.10.1

2 release files

1.9.2

2 release files

1.8.2

2 release files

1.8.1

2 release files

1.7.4

2 release files

1.7.3

2 release files

1.7.2

2 release files

1.7.1

2 release files

1.6.9

2 release files

1.6.7

2 release files

1.6.6

2 release files

1.6.5

2 release files

1.6.3

2 release files

1.6.2

2 release files

1.6.1

2 release files

1.5.6

2 release files

1.5.5

2 release files

1.5.4

2 release files

1.5.3

2 release files

1.5.1

2 release files

1.4.3

2 release files

1.4.2

2 release files

1.4.1

2 release files

1.3.3

2 release files

1.3.2

2 release files

1.3.1

2 release files

1.2.5

2 release files

1.2.4

2 release files

1.2.3

2 release files

1.2.1

2 release files

1.1.4

2 release files

1.1.3

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.0.9

2 release files

1.0.8

2 release files

1.0.7

2 release files

1.0.6

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page