Home

callusgs aims to be a complete and (mostly) typed implementation of USGS’s machine-to-machine API (v1.5.0). In addition, callusgs provides a suite of command line tools that can be used to query and download scenes, use the geocoding service provided by the USGSS and convert WRS 1/2 coordinates to geographic coordinates.

See also

Setup

More detailed setup information for callusgs

User Guide

How to provide callUSGS with your login credentials and other login methods.

API Restrictions

What can be expected to function when not applying for the MACHINE role.

Features

callusgs is both a Python package and a suite of command line tools that allows

1. Downloading of select products (see table below)

2. Access to the USGS geocoding API

3. Conversion between the WRS1 and WRS2 grids to geographic coordinates and

4. clean up of download order queues (mainly as utility functionality)

Currently supported products for download are:

Product string	Prodcut Name
landsat_em_c2_l1	Landsat 4/5 Collection 2 Level 1
landsat_em_c2_l2	Landsat 4/5 Collection 2 Level 1
landsat_etm_c2_l1	Landsat 7 Collection 2 Level 1
landsat_etm_c2_l2	Landsat 7 Collection 2 Level 2
landsat_ot_c2_l1	Landsat 8/9 Collection 2 Level 1
landsat_ot_c2_l2	Landsat 8/9 Collection 2 Level 2
landsat_ba_tile_c2	Landsat Burned Area Product
landsat_dswe_tile_c2	Landsat Dynamic Surface Water Extent
landsat_fsca_tile_c2	Landsat Fractional Snow Covered Area
gmted2010	GMTED 2010 DEM
srtm	SRTM Non-Void Filled
srtm_v2	SRTM Void Filled
srtm_v3	SRTM 1 Arc-Second Global
srtm_water_bodies	SRTM Water Body Data

Installation

Install the package together with the respective command line applications from pip.

pip install callusgs

Alternatively, if you’re only interested in the CLI functionality of this tool the best choice is probably to use pipx for installation.

pipx install callusgs

Citation

If you’re using callusgs in your work, please cite it according to the CITATION file. A ready-to-use bibtex entry is listed below.

 1 # This CITATION.cff file was generated with cffinit.
 2 # Visit https://bit.ly/cffinit to generate yours today!
 3 
 4 cff-version: 1.2.0
 5 title: callusgs
 6 message: >-
 7   If you use this software, please cite it using the
 8   metadata from this file.
 9 type: software
10 authors:
11   - given-names: Florian
12     family-names: Katerndahl
13     orcid: 'https://orcid.org/0000-0001-6137-061X'
14     email: florian@katerndahl.com
15 identifiers:
16   - type: doi
17     value: 10.5281/zenodo.13319174
18 repository-code: 'https://github.com/Florian-Katerndahl/callusgs'
19 abstract: >-
20   callusgs Aims To Be A Complete Implementation Of USGS's
21   machine-to-machine API (v1.5.0)
22 keywords:
23   - api
24   - cli
25   - gis
26   - geodata
27   - landsat
28   - usgs
29   - machine-to-machine
30   - eros
31   - download
32   - earthexplorer
33 license: GPL-2.0
34 version: v0.3.0
35 date-released: '2024-08-20'

@software{Katerndahl2024,
   author = {Katerndahl, Florian},
   doi = {10.5281/zenodo.13319174},
   version = {v0.3.0},
   month = {8},
   title = {callusgs},
   url = {https://github.com/Florian-Katerndahl/callusgs},
   year = {2024}
}