Package: usgsm2m
DescriptionTheusgsm2mPython package provides an interface to theUSGS M2Mportal to search and download scenes through a command-line interface or a Python API.The following datasets are supported based on only entityid provided. For the different dataset other than this list requires the dataset name. The bulk download is also supported with resume facility.Dataset NameDataset IDLandsat 5 TM Collection 1 Level 1landsat_tm_c1Landsat 5 TM Collection 2 Level 1landsat_tm_c2_l1Landsat 5 TM Collection 2 Level 2landsat_tm_c2_l2Landsat 7 ETM+ Collection 1 Level 1landsat_etm_c1Landsat 7 ETM+ Collection 2 Level 1landsat_etm_c2_l1Landsat 7 ETM+ Collection 2 Level 2landsat_etm_c2_l2Landsat 8 Collection 1 Level 1landsat_8_c1Landsat 8 Collection 2 Level 1landsat_ot_c2_l1Landsat 8 Collection 2 Level 2landsat_ot_c2_l2Sentinel 2Asentinel_2aQuick startSearching for Landsat 5 TM scenes that contains the location (12.53, -1.53) acquired during the year 1995.Set theusgsm2m search --dataset LANDSAT_ETM_C2_L2 --location 30.32 78.03 --clouds 5  --start 2005-01-01 --end 2005-12-31Search for Landsat 7 ETM scenes in Brussels with less than 5% of clouds. Save the returned results in a.csvfile.usgsm2m search --dataset LANDSAT_ETM_C2_L2 --location 30.32 78.03 --clouds 5  --start 2005-01-01 --end 2005-12-31 > result.csvDownloading three Landsat scenes from different the entity file containingdisplay idthe current directory.usgsm2m downloadbulk --entityfile result.csvDownloading three Landsat scenes from different datasets in the current directory.usgsm2m download LT51960471995178MPS00 LC80390222013076EDC00 LC82150682015350LGN01To use the package, Earth Explorer credentials are required (registration).InstallationThe package can be installed using pip.pip install usgsm2mUsageusgsm2mcan be used both through its command-line interface and as a Python module.Command-line interfaceusgsm2m --helpUsage: usgsm2m [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  download  Download one or several Landsat scenes.
  search    Search for Landsat scenes.CredentialsCredentials for the Earth Explorer portal can be obtainedhere.--usernameand--passwordcan be provided as command-line options or as environment variables:exportUSGSM2M_USERNAME=<your_username>exportUSGSM2M_PASSWORD=<your_password>Searchingusgsm2m search --helpUsage: usgsm2m search [OPTIONS]

  Search for Landsat scenes.

Options:
  -u, --username TEXT             EarthExplorer username.
  -p, --password TEXT             EarthExplorer password.
  -d, --dataset [landsat_tm_c1|landsat_etm_c1|landsat_8_c1|landsat_tm_c2_l1|landsat_tm_c2_l2|landsat_etm_c2_l1|landsat_etm_c2_l2|landsat_ot_c2_l1|landsat_ot_c2_l2|sentinel_2a]
                                  Landsat data set.
  -l, --location FLOAT...         Point of interest (latitude, longitude).
  -b, --bbox FLOAT...             Bounding box (xmin, ymin, xmax, ymax).
  -c, --clouds INTEGER            Max. cloud cover (1-100).
  -s, --start TEXT                Start date (YYYY-MM-DD).
  -e, --end TEXT                  End date (YYYY-MM-DD).
  -o, --output [entity_id|display_id|json|csv]
                                  Output format.
  -m, --limit INTEGER             Max. results returned.
  --help                          Show this message and exit.Downloadingusgsm2m download --helpUsage: usgsm2m download [OPTIONS] [SCENES]...

  Download one or several Landsat scenes.

Options:
  -u, --username TEXT    EarthExplorer username.
  -p, --password TEXT    EarthExplorer password.
  -d, --dataset TEXT     Dataset.
  -o, --output PATH      Output directory.
  -t, --timeout INTEGER  Download timeout in seconds.
  --skip
  --help                 Show this message and exit.If the--datasetis not provided, the dataset is automatically guessed from the scene identifier. Note that only the newer Landsat Product Identifiers contain information related to collection number and processing level. To download Landsat Collection 2 products, use Product IDs or set the--datasetoption correctly. The download supports the parallel download.Bulk Downloadusgsm2m download --helpUsage: cli.py downloadbulk [OPTIONS]

  Download one or several scenes.

Options:
  -u, --username TEXT    USGS M2M username.
  -p, --password TEXT    USGS M2M password.
  -d, --dataset TEXT     Dataset
  -e, --entityfile PATH  Entity File Name  [required]
  -o, --output PATH      Output directory.
  -f, --filetype TEXT    Download File Type {'bundle','band'}
  -i, --idfield TEXT     Entity Id Type {'displayId','entityId'}
  -t, --timeout INTEGER  Download timeout in seconds.
  --skip
  --help                 Show this message and exit.The --entityfile must contains the scene identifier in each line.If the--datasetis not provided, the dataset is automatically guessed from the scene identifier. Note that only the newer Landsat Product Identifiers contain information related to collection number and processing level.APIUSGS APIusgsm2mprovides an interface to the  USGS M2M JSON API. Please refer to the official (documentation) for possible request codes and parameters.Basic usagefromusgsm2m.apiimportAPI# Initialize a new API instance and get an access keyapi=API(username,password)# Perform a request. Results are returned in a dictionnaryresponse=api.request('<request_endpoint>',params={"param_1":value_1,"param_2":value_2})# Log outapi.logout()Please refer to the officialJSON API Referencefor a list of all available requests.Searching for scenesimportjsonfromUSGSM2M.apiimportAPI# Initialize a new API instance and get an access keyapi=API(username,password)# Search for Landsat TM scenesscenes=api.search(dataset='landsat_tm_c1',latitude=50.85,longitude=-4.35,start_date='1995-01-01',end_date='1995-10-01',max_cloud_cover=10)print(f"{len(scenes)}scenes found.")# Process the resultforsceneinscenes:print(scene['acquisition_date'].strftime('%Y-%m-%d'))# Write scene footprints to diskfname=f"{scene['landsat_product_id']}.geojson"withopen(fname,"w")asf:json.dump(scene['spatial_coverage'].__geo_interface__,f)api.logout()Output:4 scenes found.
1995-09-23
1995-08-22
1995-08-15
1995-06-28Downloading scenesfromusgsm2m.usgsm2mimportUSGSM2Mee=USGSM2M(username,password)ee.download('LT51960471995178MPS00',output_dir='./data')ee.logout()