Skip to main content

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.

Project description

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

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

py-eodms-rapi-1.10.3.tar.gz (40.1 kB view details)

Uploaded Source

Built Distribution

py_eodms_rapi-1.10.3-py3-none-any.whl (39.6 kB view details)

Uploaded Python 3

File details

Details for the file py-eodms-rapi-1.10.3.tar.gz.

File metadata

  • Download URL: py-eodms-rapi-1.10.3.tar.gz
  • Upload date:
  • Size: 40.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.10

File hashes

Hashes for py-eodms-rapi-1.10.3.tar.gz
Algorithm Hash digest
SHA256 ae3ab9daa9fb88272124fda3e3c50e4cb3ea2234cdfb147ea70a9b581cd3ccf6
MD5 058fde124b2272da75271ee1e3b23775
BLAKE2b-256 3fe656848034ba3b283559abc69db22de90a7bb5f27de51643890f651b5f6b23

See more details on using hashes here.

File details

Details for the file py_eodms_rapi-1.10.3-py3-none-any.whl.

File metadata

  • Download URL: py_eodms_rapi-1.10.3-py3-none-any.whl
  • Upload date:
  • Size: 39.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.10

File hashes

Hashes for py_eodms_rapi-1.10.3-py3-none-any.whl
Algorithm Hash digest
SHA256 708487a3dd68702fd0028d8eef193945d11b8a20bcf31b2c4e531aa5975c535a
MD5 ef985e540924ab5b8037c220e784f47a
BLAKE2b-256 f5753366840ce3844a82febf24aac4a6eca25e11529c93bd99afe603f0deb144

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