| Name | usgs-libcomcat JSON |
| Version |
2.1.6
JSON |
| download |
| home_page | None |
| Summary | Python wrapper around ComCat web API |
| upload_time | 2024-08-28 19:35:36 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | License ======= Unless otherwise noted, This project is in the public domain in the United States because it contains materials that originally came from the United States Geological Survey, an agency of the United States Department of Interior. For more information, see the official USGS copyright policy at https://www2.usgs.gov/visual-id/credit_usgs.html#copyright Additionally, we waive copyright and related rights in the work worldwide through the CC0 1.0 Universal public domain dedication. CC0 1.0 Universal Summary ------------------------- This is a human-readable summary of the [Legal Code (read the full text)][1]. ### No Copyright The person who associated a work with this deed has dedicated the work to the public domain by waiving all of his or her rights to the work worldwide under copyright law, including all related and neighboring rights, to the extent allowed by law. You can copy, modify, distribute and perform the work, even for commercial purposes, all without asking permission. ### Other Information In no way are the patent or trademark rights of any person affected by CC0, nor are the rights that other persons may have in the work or in how the work is used, such as publicity or privacy rights. Unless expressly stated otherwise, the person who associated a work with this deed makes no warranties about the work, and disclaims liability for all uses of the work, to the fullest extent permitted by applicable law. When using or citing the work, you should not imply endorsement by the author or the affirmer. ## Contributed Data libcomcat makes use of a publicly available data set from Natural Earth (country boundaries), which we have included in this repository with great appreciation for the original authors. The usage terms of that data set is included below: "All versions of Natural Earth raster + vector map data found on this website are in the public domain. You may use the maps in any manner, including modifying the content and design, electronic dissemination, and offset printing. The primary authors, Tom Patterson and Nathaniel Vaughn Kelso, and all other contributors renounce all financial claim to the maps and invites you to use them for personal, educational, and commercial purposes." |
| keywords |
comcat
earthquake
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Table of Contents
- [Table of Contents](#table-of-contents)
- [Introduction](#introduction)
- [Installation](#installation)
- [Uninstalling and Updating](#uninstalling-and-updating)
- [Motivation](#motivation)
- [Documentation](#documentation)
- [Getting Help](#getting-help)
- [Citation](#citation)
# Introduction
libcomcat is a project designed to provide a Python equivalent to the ANSS ComCat search
<a href="https://earthquake.usgs.gov/fdsnws/event/1/">API</a>. This includes a Python library
that provides various classes and functions wrapping around the ComCat API, and a number of command
line programs that use those:
* `findid` Find the ID of an event closest to input parameters (time, latitude, longitude). Also can provide the authoritative ID if an event id is provided.
* `getcsv` Generate csv or Excel files with basic earthquake information.
* `geteventhist` Generate csv or Excel files with a history of product submission for an event.
* `getmags` Download all available magnitudes from all sources.
* `getpager` Download information that represents the PAGER exposure and loss results.
* `getphases` Generate csv or Excel files with phase information.
* `getproduct` Download ComCat product contents (shakemap grids, origin quakeml, etc.)
# Installation
`libcomcat` is now installable via pip:
`pip install usgs-libcomcat`
### Uninstalling and Updating
To uninstall:
`pip uninstall usgs-libcomcat`
To update:
`pip install --upgrade usgs-libcomcat`
# Motivation
libcomcat is a python wrapper for the Comprehensive Catalog (ComCat), which has a [web page interface](https://earthquake.usgs.gov/earthquakes/map/) and [API](https://earthquake.usgs.gov/fdsnws/event/1/). ComCat contains information in **Events** which contain **Products**. Products contain **Contents** in the form of files, maps, etc.
The ComCat interface is very user friendly, but does not support automation. The API supports automation, but limits the number of events that can be returned to 20,000. libcomcat uses the API in a way that allows for:
- Searches returning more than 20,000 eventsource
- Automation of product file downloads
- Extraction of information in product content files
# Documentation
Documentation can be found in the docs folder:
- [API Documentation](https://code.usgs.gov/ghsc/esi/libcomcat-python/-/blob/master/docs/api.md)
- [Command Line Interface Documentation](https://code.usgs.gov/ghsc/esi/libcomcat-python/-/blob/master/docs/cli.md)
Example Jupyter notebooks show how the API can be used to get and manipulate information from ComCat:
*Note: The ShakeMap/DYFI Station Pairs Notebook requires a geodetic distance calculation function*
*, which can be installed via: `pip install geopy`*
- [Classes Notebook](https://code.usgs.gov/ghsc/esi/libcomcat-python/-/blob/master/notebooks/Classes.ipynb)
- [Dataframes Notebook](https://code.usgs.gov/ghsc/esi/libcomcat-python/-/blob/master/notebooks/Dataframes.ipynb)
- [Detailed Event Notebook](https://code.usgs.gov/ghsc/esi/libcomcat-python/-/blob/master/notebooks/DetailEvent.ipynb)
- [Event History Notebook](https://code.usgs.gov/ghsc/esi/libcomcat-python/-/blob/master/notebooks/EventHistory.ipynb)
- [Magnitude Comparison Notebook](https://code.usgs.gov/ghsc/esi/libcomcat-python/-/blob/master/notebooks/ComparingMagnitudes.ipynb)
- [Phase and Magnitude Notebook](https://code.usgs.gov/ghsc/esi/libcomcat-python/-/blob/master/notebooks/PhasesAndMagnitudes.ipynb)
- [Search Notebook](https://code.usgs.gov/ghsc/esi/libcomcat-python/-/blob/master/notebooks/Search.ipynb)
- [Get ShakeMap/DYFI Station Pairs Notebook](https://code.usgs.gov/ghsc/esi/libcomcat-python/-/blob/master/notebooks/GetSMDYFIPairs.ipynb)
# Getting Help
Any questions about libcomcat can be directed to the primary author:
Mike Hearne
mhearne@usgs.gov
# Citation
If you wish to cite this work in your own publication, you may use this DOI:
https://doi.org/10.5066/P91WN1UQ
Raw data
{
"_id": null,
"home_page": null,
"name": "usgs-libcomcat",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "comcat, earthquake",
"author": null,
"author_email": "Mike Hearne <mhearne@usgs.gov>, Heather Hunsinger <hhunsinger@usgs.gov>",
"download_url": "https://files.pythonhosted.org/packages/d1/54/93536f0b85c16fb282b6f9c6c519b6cbd2a9ee8711e765b0a8e679ec4b7d/usgs_libcomcat-2.1.6.tar.gz",
"platform": null,
"description": "# Table of Contents\n- [Table of Contents](#table-of-contents)\n- [Introduction](#introduction)\n- [Installation](#installation)\n - [Uninstalling and Updating](#uninstalling-and-updating)\n- [Motivation](#motivation)\n- [Documentation](#documentation)\n- [Getting Help](#getting-help)\n- [Citation](#citation)\n\n# Introduction\n\n\nlibcomcat is a project designed to provide a Python equivalent to the ANSS ComCat search\n<a href=\"https://earthquake.usgs.gov/fdsnws/event/1/\">API</a>. This includes a Python library\nthat provides various classes and functions wrapping around the ComCat API, and a number of command\nline programs that use those:\n\n* `findid` Find the ID of an event closest to input parameters (time, latitude, longitude). Also can provide the authoritative ID if an event id is provided.\n* `getcsv` Generate csv or Excel files with basic earthquake information.\n* `geteventhist` Generate csv or Excel files with a history of product submission for an event.\n * `getmags` Download all available magnitudes from all sources.\n * `getpager` Download information that represents the PAGER exposure and loss results.\n * `getphases` Generate csv or Excel files with phase information.\n * `getproduct` Download ComCat product contents (shakemap grids, origin quakeml, etc.)\n\n\n# Installation\n`libcomcat` is now installable via pip:\n\n`pip install usgs-libcomcat`\n\n### Uninstalling and Updating\n\nTo uninstall:\n\n`pip uninstall usgs-libcomcat`\n\nTo update:\n\n`pip install --upgrade usgs-libcomcat`\n\n# Motivation\n\nlibcomcat is a python wrapper for the Comprehensive Catalog (ComCat), which has a [web page interface](https://earthquake.usgs.gov/earthquakes/map/) and [API](https://earthquake.usgs.gov/fdsnws/event/1/). ComCat contains information in **Events** which contain **Products**. Products contain **Contents** in the form of files, maps, etc.\n\nThe ComCat interface is very user friendly, but does not support automation. The API supports automation, but limits the number of events that can be returned to 20,000. libcomcat uses the API in a way that allows for:\n- Searches returning more than 20,000 eventsource\n- Automation of product file downloads\n- Extraction of information in product content files\n\n# Documentation\n\nDocumentation can be found in the docs folder:\n- [API Documentation](https://code.usgs.gov/ghsc/esi/libcomcat-python/-/blob/master/docs/api.md)\n- [Command Line Interface Documentation](https://code.usgs.gov/ghsc/esi/libcomcat-python/-/blob/master/docs/cli.md)\n\nExample Jupyter notebooks show how the API can be used to get and manipulate information from ComCat:\n\n*Note: The ShakeMap/DYFI Station Pairs Notebook requires a geodetic distance calculation function*\n*, which can be installed via: `pip install geopy`*\n\n- [Classes Notebook](https://code.usgs.gov/ghsc/esi/libcomcat-python/-/blob/master/notebooks/Classes.ipynb)\n- [Dataframes Notebook](https://code.usgs.gov/ghsc/esi/libcomcat-python/-/blob/master/notebooks/Dataframes.ipynb)\n- [Detailed Event Notebook](https://code.usgs.gov/ghsc/esi/libcomcat-python/-/blob/master/notebooks/DetailEvent.ipynb)\n- [Event History Notebook](https://code.usgs.gov/ghsc/esi/libcomcat-python/-/blob/master/notebooks/EventHistory.ipynb)\n- [Magnitude Comparison Notebook](https://code.usgs.gov/ghsc/esi/libcomcat-python/-/blob/master/notebooks/ComparingMagnitudes.ipynb)\n- [Phase and Magnitude Notebook](https://code.usgs.gov/ghsc/esi/libcomcat-python/-/blob/master/notebooks/PhasesAndMagnitudes.ipynb)\n- [Search Notebook](https://code.usgs.gov/ghsc/esi/libcomcat-python/-/blob/master/notebooks/Search.ipynb)\n- [Get ShakeMap/DYFI Station Pairs Notebook](https://code.usgs.gov/ghsc/esi/libcomcat-python/-/blob/master/notebooks/GetSMDYFIPairs.ipynb)\n\n# Getting Help\n\nAny questions about libcomcat can be directed to the primary author:\n\nMike Hearne\nmhearne@usgs.gov\n# Citation\n\nIf you wish to cite this work in your own publication, you may use this DOI:\nhttps://doi.org/10.5066/P91WN1UQ\n\n",
"bugtrack_url": null,
"license": "License ======= Unless otherwise noted, This project is in the public domain in the United States because it contains materials that originally came from the United States Geological Survey, an agency of the United States Department of Interior. For more information, see the official USGS copyright policy at https://www2.usgs.gov/visual-id/credit_usgs.html#copyright Additionally, we waive copyright and related rights in the work worldwide through the CC0 1.0 Universal public domain dedication. CC0 1.0 Universal Summary ------------------------- This is a human-readable summary of the [Legal Code (read the full text)][1]. ### No Copyright The person who associated a work with this deed has dedicated the work to the public domain by waiving all of his or her rights to the work worldwide under copyright law, including all related and neighboring rights, to the extent allowed by law. You can copy, modify, distribute and perform the work, even for commercial purposes, all without asking permission. ### Other Information In no way are the patent or trademark rights of any person affected by CC0, nor are the rights that other persons may have in the work or in how the work is used, such as publicity or privacy rights. Unless expressly stated otherwise, the person who associated a work with this deed makes no warranties about the work, and disclaims liability for all uses of the work, to the fullest extent permitted by applicable law. When using or citing the work, you should not imply endorsement by the author or the affirmer. ## Contributed Data libcomcat makes use of a publicly available data set from Natural Earth (country boundaries), which we have included in this repository with great appreciation for the original authors. The usage terms of that data set is included below: \"All versions of Natural Earth raster + vector map data found on this website are in the public domain. You may use the maps in any manner, including modifying the content and design, electronic dissemination, and offset printing. The primary authors, Tom Patterson and Nathaniel Vaughn Kelso, and all other contributors renounce all financial claim to the maps and invites you to use them for personal, educational, and commercial purposes.\" ",
"summary": "Python wrapper around ComCat web API",
"version": "2.1.6",
"project_urls": null,
"split_keywords": [
"comcat",
" earthquake"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "91002f4eb154dd70841b4c3281985f807f485f9fbdcd074aed76360612057b3f",
"md5": "8e5baadb969109ee5a563b2cbd555b77",
"sha256": "066df927dc7bfcc8bcc7472afdc9ebdf325ee555faa6f139da2385cdd5682f02"
},
"downloads": -1,
"filename": "usgs_libcomcat-2.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8e5baadb969109ee5a563b2cbd555b77",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 975609,
"upload_time": "2024-08-28T19:35:34",
"upload_time_iso_8601": "2024-08-28T19:35:34.815187Z",
"url": "https://files.pythonhosted.org/packages/91/00/2f4eb154dd70841b4c3281985f807f485f9fbdcd074aed76360612057b3f/usgs_libcomcat-2.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d15493536f0b85c16fb282b6f9c6c519b6cbd2a9ee8711e765b0a8e679ec4b7d",
"md5": "f37beae0fc0c2383e5e1138f36a0cc78",
"sha256": "162ec87b45d44a53b27e60fabce20ab9671fe067bf6bb467ce8ee2e84a08d5e5"
},
"downloads": -1,
"filename": "usgs_libcomcat-2.1.6.tar.gz",
"has_sig": false,
"md5_digest": "f37beae0fc0c2383e5e1138f36a0cc78",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 957673,
"upload_time": "2024-08-28T19:35:36",
"upload_time_iso_8601": "2024-08-28T19:35:36.691057Z",
"url": "https://files.pythonhosted.org/packages/d1/54/93536f0b85c16fb282b6f9c6c519b6cbd2a9ee8711e765b0a8e679ec4b7d/usgs_libcomcat-2.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-28 19:35:36",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "usgs-libcomcat"
}
