Package: aio-geojson-usgs-earthquakes
python-aio-geojson-usgs-earthquakesThis library provides convenient async access to U.S. Geological Survey Earthquake Hazards Program feeds.Installationpip install aio-geojson-usgs-earthquakesUsageSee below for examples of how this library can be used. After instantiating a
particular class - feed or feed manager - and supply the required parameters,
you can callupdateto retrieve the feed data. The return value
will be a tuple of a status code and the actual data in the form of a list of
feed entries specific to the selected feed.Status CodesOK: Update went fine and data was retrieved. The library may still
return empty data, for example because no entries fulfilled the filter
criteria.OK_NO_DATA: Update went fine but no data was retrieved, for example
because the server indicated that there was not update since the last request.ERROR: Something went wrong during the updateParametersParameterDescriptionhome_coordinatesCoordinates (tuple of latitude/longitude)Supported FeedsCategoryFeedPast Hour - Significant Earthquakespast_hour_significant_earthquakesPast Hour - M4.5+ Earthquakespast_hour_m45_earthquakesPast Hour - M2.5+ Earthquakespast_hour_m25_earthquakesPast Hour - M1.0+ Earthquakespast_hour_m10_earthquakesPast Hour - All Earthquakespast_hour_all_earthquakesPast Day - Significant Earthquakespast_day_significant_earthquakesPast Day - M4.5+ Earthquakespast_day_m45_earthquakesPast Day - M2.5+ Earthquakespast_day_m25_earthquakesPast Day - M1.0+ Earthquakespast_day_m10_earthquakesPast Day - All Earthquakespast_day_all_earthquakesPast 7 Days - Significant Earthquakespast_week_significant_earthquakesPast 7 Days - M4.5+ Earthquakespast_week_m45_earthquakesPast 7 Days - M2.5+ Earthquakespast_week_m25_earthquakesPast 7 Days - M1.0+ Earthquakespast_week_m10_earthquakesPast 7 Days - All Earthquakespast_week_all_earthquakesPast 30 Days - Significant Earthquakespast_month_significant_earthquakesPast 30 Days - M4.5+ Earthquakespast_month_m45_earthquakesPast 30 Days - M2.5+ Earthquakespast_month_m25_earthquakesPast 30 Days - M1.0+ Earthquakespast_month_m10_earthquakesPast 30 Days - All Earthquakespast_month_all_earthquakesSupported FiltersFilterDescriptionRadiusfilter_radiusRadius in kilometers around the home coordinates in which events from feed are included.Minimum Magnitudefilter_minimum_magnitudeMinimum magnitude as float value. Only event with a magnitude equal or above this value are included.ExampleimportasynciofromaiohttpimportClientSessionfromaio_geojson_usgs_earthquakesimportUsgsEarthquakeHazardsProgramFeedasyncdefmain()->None:asyncwithClientSession()aswebsession:# Home Coordinates: Latitude: 21.3, Longitude: -157.8# Feed: Past Day - All Earthquakes# Filter radius: 500 km# Filter minimum magnitude: 4.0feed=UsgsEarthquakeHazardsProgramFeed(websession,(21.3,-157.8),'past_day_all_earthquakes',filter_radius=5000,filter_minimum_magnitude=4.0)status,entries=awaitfeed.update()print(status)print(entries)asyncio.get_event_loop().run_until_complete(main())Feed entry propertiesEach feed entry is populated with the following properties:NameDescriptionFeed attributegeometriesAll geometry details of this entry.geometrycoordinatesBest coordinates (latitude, longitude) of this entry.geometrydistance_to_homeDistance in km of this entry to the home coordinates.n/aattributionAttribution of the feed.n/aexternal_idThe unique public identifier for this entry.idtitleTitle of this entry.titleplaceDescription of the place where this earthquakes occurred.placemagnitudeMagnitude of this earthquake.magtimeDate and time when this event occurred.timeupdatedDate and time when this entry was last updated.updatedalertAlert level of this entry ("green", "yellow", "orange", "red").alerttypeType of this seismic event ("earthquake", "quarry").typestatusIndicates whether the event has been reviewed by a human ("automatic", "reviewed", "deleted").statusFeed ManagerThe Feed Manager helps managing feed updates over time, by notifying the
consumer of the feed about new feed entries, updates and removed entries
compared to the last feed update.If the current feed update is the first one, then all feed entries will be
reported as new. The feed manager will keep track of all feed entries'
external IDs that it has successfully processed.If the current feed update is not the first one, then the feed manager will
produce three sets:Feed entries that were not in the previous feed update but are in the
current feed update will be reported as new.Feed entries that were in the previous feed update and are still in the
current feed update will be reported as to be updated.Feed entries that were in the previous feed update but are not in the
current feed update will be reported to be removed.If the current update fails, then all feed entries processed in the previous
feed update will be reported to be removed.After a successful update from the feed, the feed manager provides two
different dates:last_updatewill be the timestamp of the last update from the feed
irrespective of whether it was successful or not.last_update_successfulwill be the timestamp of the last successful update
from the feed. This date may be useful if the consumer of this library wants
to treat intermittent errors from feed updates differently.last_timestamp(optional, depends on the feed data) will be the latest
timestamp extracted from the feed data.
This requires that the underlying feed data actually contains a suitable
date. This date may be useful if the consumer of this library wants to
process feed entries differently if they haven't actually been updated.