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.4.tar.gz (40.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: py-eodms-rapi-1.10.4.tar.gz
  • Upload date:
  • Size: 40.0 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.4.tar.gz
Algorithm Hash digest
SHA256 a9642e37e2bc25e58b0b354b473711f3ee4f14ef030c0f00fcb685721669b607
MD5 451833df8439547718d20ec141ca28cc
BLAKE2b-256 ab5ba776af5bb293f69c984d88b39734ddb74a097e0a9a74247038b2dc297e61

See more details on using hashes here.

File details

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

File metadata

  • Download URL: py_eodms_rapi-1.10.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 edf05bc63ed31ee9426b69cfdf92a92bc0b285c03f299594719f0b719ce352ab
MD5 39936183bffc2c2b7ec1cd1d74e75d97
BLAKE2b-256 b87e1c4812137e53a6759fe1046cd0da5e9b04663b1387d2927f83f3bd65a489

See more details on using hashes here.

Supported by

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