{ "info": { "author": "Yann Forget", "author_email": "yannforget@mailbox.org", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "Intended Audience :: Science/Research", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Scientific/Engineering :: GIS" ], "description": "# Description\n\n![CLI Demo](https://raw.githubusercontent.com/yannforget/landsatxplore/master/demo.gif?s=0.5)\n\nThe **landsatxplore** Python package provides an interface to the [EarthExplorer](http://earthexplorer.usgs.gov/) portal to search and download [Landsat Collections](https://landsat.usgs.gov/landsat-collections) scenes through a command-line interface or a Python API.\n\nIt supports three data sets: `LANDSAT_TM_C1`, `LANDSAT_ETM_C1` and `LANDSAT_8_C1`.\n\n# Quick start\n\nSearching for Landsat 5 TM scenes that contains the location (12.53, -1.53) acquired during the year 1995.\n\n```\nlandsatxplore search --dataset LANDSAT_TM_C1 --location 12.53 -1.53 \\\n --start 1995-01-01 --end 1995-12-31\n```\n\nSearch for Landsat 7 ETM scenes in Brussels with less than 5% of clouds. Save the returned results in a `.csv` file.\n\n```\nlandsatxplore search --dataset LANDSAT_ETM_C1 \\\n --location 50.83 4.38 --clouds 5 > results.csv\n```\n\nDownloading three Landsat scenes from different datasets in the current directory.\n\n```\nlandsatxplore download LT51960471995178MPS00 LC80390222013076EDC00 LC82150682015350LGN01\n```\n\nTo use the package, Earth Explorer credentials are required ([registration](https://ers.cr.usgs.gov/register/)).\n\n# Installation\n\nThe package can be installed using pip.\n\n```\npip install landsatxplore\n```\n\n# Usage\n\n**landsatxplore** can be used both through its command-line interface and as a Python module.\n\n## Command-line interface\n\n```\nlandsatxplore --help\n```\n\n```\nUsage: landsatxplore [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n --help Show this message and exit.\n\nCommands:\n download Download one or several Landsat scenes.\n search Search for Landsat scenes.\n```\n\n### Credentials\n\nCredentials for the Earth Explorer portal can be obtained [here](https://ers.cr.usgs.gov/register/).\n\n`--username` and `--password` can be provided as command-line options or as environment variables:\n\n``` shell\nexport LANDSATXPLORE_USERNAME=\nexport LANDSATXPLORE_PASSWORD=\n```\n\n### Searching\n\n```\nlandsatxplore search --help\n```\n\n```\nUsage: landsatxplore search [OPTIONS]\n\n Search for Landsat scenes.\n\nOptions:\n -u, --username TEXT EarthExplorer username.\n -p, --password TEXT EarthExplorer password.\n -d, --dataset [LANDSAT_TM_C1|LANDSAT_ETM_C1|LANDSAT_8_C1]\n Landsat data set.\n -l, --location FLOAT... Point of interest (latitude, longitude).\n -b, --bbox FLOAT... Bounding box (xmin, ymin, xmax, ymax).\n -c, --clouds INTEGER Max. cloud cover (1-100).\n -s, --start TEXT Start date (YYYY-MM-DD).\n -e, --end TEXT End date (YYYY-MM-DD).\n -o, --output [scene_id|product_id|json|csv]\n Output format.\n -m, --limit INTEGER Max. results returned.\n --help Show this message and exit.\n```\n\n### Downloading\n\n```\nlandsatxplore download --help\n```\n\n```\nUsage: landsatxplore download [OPTIONS] [SCENES]...\n\n Download one or several Landsat scenes.\n\nOptions:\n -u, --username TEXT EarthExplorer username.\n -p, --password TEXT EarthExplorer password.\n -o, --output PATH Output directory (default to current).\n --help Show this message and exit.\n```\n\n## API\n\n### EarthExplorer API\n\n**landsatxplore** provides an interface to the Earth Explorer JSON API. Please refer to the official ([documentation](https://earthexplorer.usgs.gov/inventory/documentation/json-api)) for possible request codes and parameters.\n\n#### Basic usage\n\n``` python\nimport landsatxplore.api\n\n# Initialize a new API instance and get an access key\napi = landsatxplore.api.API(username, password)\n\n# Perform a request. Results are returned in a dictionnary\nresponse = api.request('', parameter1=value1, parameter2=value2)\n\n#\u00a0Log out\napi.logout()\n```\n\n#### Searching for scenes\n\n``` python\nimport landsatxplore.api\n\n# Initialize a new API instance and get an access key\napi = landsatxplore.api.API(username, password)\n\n# Request\nscenes = api.search(\n dataset='LANDSAT_ETM_C1',\n latitude=19.53,\n longitude=-1.53,\n start_date='1995-01-01',\n end_date='1997-01-01',\n max_cloud_cover=10)\n\nprint('{} scenes found.'.format(len(scenes)))\n\nfor scene in scenes:\n print(scene['acquisitionDate'])\n\napi.logout()\n```\n\nOutput:\n\n```\n8 scenes found.\n1995-05-10\n1995-05-26\n1995-06-11\n1995-06-11\n1995-06-27\n1995-07-29\n1995-08-14\n1995-08-14\n```\n\n#### Downloading scenes\n\n``` python\nfrom landsatxplore.earthexplorer import EarthExplorer\n\nee = EarthExplorer(username, password)\n\nee.download(scene_id='LT51960471995178MPS00', output_dir='./data')\n\nee.logout()\n```\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/yannforget/landsatxplore", "keywords": "earth observation,remote sensing,satellite imagery,landsat", "license": "", "maintainer": "", "maintainer_email": "", "name": "landsatxplore", "package_url": "https://pypi.org/project/landsatxplore/", "platform": "", "project_url": "https://pypi.org/project/landsatxplore/", "project_urls": { "Homepage": "https://github.com/yannforget/landsatxplore" }, "release_url": "https://pypi.org/project/landsatxplore/0.6/", "requires_dist": [ "requests", "tqdm", "click" ], "requires_python": "", "summary": "Search and download Landsat scenes from EarthExplorer.", "version": "0.6" }, "last_serial": 5634112, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "56c33302c3048ae0637355193987df33", "sha256": "dbca5ee5662289743dfb805468bd68e3dbd5876b5b8495ccd601f2000c57a8e6" }, "downloads": -1, "filename": "landsatxplore-0.0.1.tar.gz", "has_sig": false, "md5_digest": "56c33302c3048ae0637355193987df33", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8076, "upload_time": "2018-04-11T20:25:40", "url": "https://files.pythonhosted.org/packages/05/88/5984c8afa9a14b420de46e4b744ab9084fddcb6e547f0e7a5fea0fa9b05d/landsatxplore-0.0.1.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "c3572739bddc2eb92e2413611c677a0d", "sha256": "9e62cf87e0f39e31be6cb205f04b9cf722a1aa26f59b4ef88ab6c5e04ad9617d" }, "downloads": -1, "filename": "landsatxplore-0.0.3.tar.gz", "has_sig": false, "md5_digest": "c3572739bddc2eb92e2413611c677a0d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10152, "upload_time": "2018-04-13T14:46:58", "url": "https://files.pythonhosted.org/packages/9b/57/39d132210fd9d5e47ec8c1107ea1aadbd4af6a08245be0be39557628e71a/landsatxplore-0.0.3.tar.gz" } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "470b48324640d4c445444efcc619fa1d", "sha256": "2da27746c15a9f8f65f223f8e48a8857ef9e51421245eeba6a964a4d04be06d6" }, "downloads": -1, "filename": "landsatxplore-0.0.4-py3-none-any.whl", "has_sig": false, "md5_digest": "470b48324640d4c445444efcc619fa1d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 9395, "upload_time": "2018-11-21T09:15:41", "url": "https://files.pythonhosted.org/packages/30/8a/2fb68b671376a52c2acd856fc70b1ee43ea008e2be61c930131e135574b8/landsatxplore-0.0.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "84a5519d674c894074103c163204d09e", "sha256": "4cd2d894d163d26e36c78b25509460b5ae36649bddd5720c09b14afc8930744c" }, "downloads": -1, "filename": "landsatxplore-0.0.4.tar.gz", "has_sig": false, "md5_digest": "84a5519d674c894074103c163204d09e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10206, "upload_time": "2018-11-21T09:15:42", "url": "https://files.pythonhosted.org/packages/e7/2e/ce9d63e51c600ea0312b71212d1377910d28cff173079f5623af8ee43b78/landsatxplore-0.0.4.tar.gz" } ], "0.0.5": [ { "comment_text": "", "digests": { "md5": "7df95b46095e931672a1632354e39984", "sha256": "b3dfd19742bc969aaa7ea97fd2f977662d432e41733d2f3a20655a99dec61da8" }, "downloads": -1, "filename": "landsatxplore-0.0.5-py3-none-any.whl", "has_sig": false, "md5_digest": "7df95b46095e931672a1632354e39984", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 9404, "upload_time": "2018-11-27T11:14:51", "url": "https://files.pythonhosted.org/packages/35/ca/f4ace3062bc956bc3bd4b8aac15e3ab8707dd051ca32ef1d285fd369b79e/landsatxplore-0.0.5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f4d878adb318523771e4ae0363eaf774", "sha256": "faa60d8821f9ff03f92d6516938fec46c0758b6844466defe1df0be7b7330e9a" }, "downloads": -1, "filename": "landsatxplore-0.0.5.tar.gz", "has_sig": false, "md5_digest": "f4d878adb318523771e4ae0363eaf774", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10221, "upload_time": "2018-11-27T11:14:53", "url": "https://files.pythonhosted.org/packages/35/3e/fc44fbf783f469f751b1df21d576aa485f3ee5c9ad47b5caccae99bf7cdb/landsatxplore-0.0.5.tar.gz" } ], "0.6": [ { "comment_text": "", "digests": { "md5": "be4fb82340a834e80aaeb1e7781460c5", "sha256": "584b0c18b551b9ec1c4b0bc232e575258e7949beb2a3467ea1908ac9e9bdd16a" }, "downloads": -1, "filename": "landsatxplore-0.6-py3-none-any.whl", "has_sig": false, "md5_digest": "be4fb82340a834e80aaeb1e7781460c5", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 10188, "upload_time": "2019-08-05T12:52:17", "url": "https://files.pythonhosted.org/packages/42/57/27e2760b520f71654fb0d0cc1e402ee6fd7b2c5acec82afce09fea29063e/landsatxplore-0.6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "53410f3b7f88bb4263ba5b06b38fabf8", "sha256": "95b485d406ed486be9e7b28f6174c990fac6b7cb409f82d862b742791b747eba" }, "downloads": -1, "filename": "landsatxplore-0.6.tar.gz", "has_sig": false, "md5_digest": "53410f3b7f88bb4263ba5b06b38fabf8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9377, "upload_time": "2019-08-05T12:52:20", "url": "https://files.pythonhosted.org/packages/41/d3/3d2745684131248fb6abcaa46abb00c916cfaadb6cf48a39440ed2379102/landsatxplore-0.6.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "be4fb82340a834e80aaeb1e7781460c5", "sha256": "584b0c18b551b9ec1c4b0bc232e575258e7949beb2a3467ea1908ac9e9bdd16a" }, "downloads": -1, "filename": "landsatxplore-0.6-py3-none-any.whl", "has_sig": false, "md5_digest": "be4fb82340a834e80aaeb1e7781460c5", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 10188, "upload_time": "2019-08-05T12:52:17", "url": "https://files.pythonhosted.org/packages/42/57/27e2760b520f71654fb0d0cc1e402ee6fd7b2c5acec82afce09fea29063e/landsatxplore-0.6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "53410f3b7f88bb4263ba5b06b38fabf8", "sha256": "95b485d406ed486be9e7b28f6174c990fac6b7cb409f82d862b742791b747eba" }, "downloads": -1, "filename": "landsatxplore-0.6.tar.gz", "has_sig": false, "md5_digest": "53410f3b7f88bb4263ba5b06b38fabf8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9377, "upload_time": "2019-08-05T12:52:20", "url": "https://files.pythonhosted.org/packages/41/d3/3d2745684131248fb6abcaa46abb00c916cfaadb6cf48a39440ed2379102/landsatxplore-0.6.tar.gz" } ] }