Skip to main content

EODMS RAPI Client

Overview

EODMS RAPI Client is a Python3 package used to access the REST API service provided by the Earth Observation Data Management System (EODMS) from Natural Resources Canada.

Installation

The package can be installed using pip:

pip install py-eodms-rapi -U

Basic Usage

Here are a few examples on how to use the EODMS RAPI Client (EODMSRAPI). For full documentation, visit https://py-eodms-rapi.readthedocs.io/en/latest/

Search for Images

from eodms_rapi import EODMSRAPI

# Create the EODMSRAPI object
rapi = EODMSRAPI('eodms-username', 'eodms-password')

# Add a point to the search
feat = [('intersects', "POINT (-96.47 62.4)")]

# Create a dictionary of query filters for the search
filters = {'Beam Mnemonic': ('=', ['16M11', '16M13']), 
            'Incidence Angle': ('>=', '35')}

# Set a date range for the search
dates = [{"start": "20200513_120000", "end": "20200613_150000"}]

# Submit the search to the EODMSRAPI, specifying the Collection
rapi.search("RCMImageProducts", filters=filters, features=feat, dates=dates)

# Get the results from the search
res = rapi.get_results('full')

# Print results
rapi.print_results()

Order and Download Images

Using the results from the previous example:

# Submit an order using results
order_res = rapi.order(res)

# Specify a folder location to download the images
dest = "C:\\temp\\py_eodms_rapi"

# Download the images from the order
dn_res = rapi.download(order_res, dest)

Acknowledgements

Some code in this package is based off the EODMS API Client designed by Mike Brady.

Contact

If you have any questions or require support, please contact the EODMS Support Team at eodms-sgdot@nrcan-rncan.gc.ca.

License

MIT License

Metadata

Release files for py-eodms-rapi 1.10.4

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

Source distribution (sdist)

Source distribution for py-eodms-rapi 1.10.4
File Size Uploaded
py-eodms-rapi-1.10.4.tar.gz 40.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for py-eodms-rapi 1.10.4
File Interpreter ABI Platform
py_eodms_rapi-1.10.4-py3-none-any.whl Python 3 none any Details

Total release size: 79.6 kB

Release files / py-eodms-rapi-1.10.4.tar.gz

Download URL py-eodms-rapi-1.10.4.tar.gz
Size 40.0 kB
Tags Source
SHA-256 checksum
How to use checksums
a9642e37e2bc25e58b0b354b473711f3ee4f14ef030c0f00fcb685721669b607
BLAKE2b-256 checksum
How to use checksums
ab5ba776af5bb293f69c984d88b39734ddb74a097e0a9a74247038b2dc297e61
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.10.10

Release files / py_eodms_rapi-1.10.4-py3-none-any.whl

Download URL py_eodms_rapi-1.10.4-py3-none-any.whl
Size 39.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
edf05bc63ed31ee9426b69cfdf92a92bc0b285c03f299594719f0b719ce352ab
BLAKE2b-256 checksum
How to use checksums
b87e1c4812137e53a6759fe1046cd0da5e9b04663b1387d2927f83f3bd65a489
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.10.10

Release history Release notifications | RSS feed

This release

1.10.4 This release

2 release files

1.10.0

2 release files

1.9.0

2 release files

1.8.0

2 release files

1.7.1

2 release files

1.7.0

2 release files

1.6.2

2 release files

1.6.1

2 release files

1.6.0

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.2

3 release files

1.5.1

2 release files

1.5.0

3 release files

1.4.6

3 release files

1.4.5

2 release files

1.4.4

2 release files

1.4.3

2 release files

1.4.2

2 release files

1.4.1

2 release files

1.4.0

2 release files

1.3.3

2 release files

1.3.2

2 release files

1.3.1

2 release files

1.3.0

2 release files

1.2.11

2 release files

1.2.10

2 release files

1.2.9

2 release files

1.2.8

2 release files

1.2.7

2 release files

1.2.6

2 release files

1.2.5

2 release files

1.2.4

2 release files

1.2.3

2 release files

1.2.2

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.1

2 release files

1.1.0

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

1.0.0

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