Skip to content
/ geteq Public

Access earthquake event records from the terminal

Notifications You must be signed in to change notification settings

jbronder/geteq

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

geteq: A USGS Earthquake Event CLI

Retrieve real-time feed and historical earthquake event records from the CLI.

Tools & Technologies

About

This is an ongoing project to construct a simple command-line application in Go using Cobra as the scaffold for the CLI. It parses commands and flags from users to send an HTTP request to USGS's real-time feed and historical earthquake data API and formats the response into a readable table to the terminal. It also forwards the request to return CSV and JSON formats of the data for further data processing and analysis. data pipeline

Sources

Real-Time Queries

Using the realtime subcommand, real-time data requests retrieve earthquake events from as far back as 30 days from the current time of the request. Real-time feed queries return a formatted table of events to the terminal.

Events can be queried within the following time intervals:

  • -t {month, week, day, hour}

Real-time queries have the following magnitude options available:

  • -m {all, 1.0, 2.5, 4.5, major}

Queries output into the following formats:

  • -o {csv, json, table} where table is a prettier format to view event records in the terminal

Real-time Feed Query Examples

Retrieve records of significant earthquakes from the past month:

$ geteq realtime -m major -t month
$ geteq realtime # "major" and "month" are the current defaults

Retrieve records of earthquakes with magnitudes greater than or equal to 4.5 in the past hour formatted to output JSON:

$ geteq rt -m 4.5 -t hour -o json

Historical Queries

The fdsn subcommand currently allows for searching earthquake catalogs bounded between date ranges and/or magnitudes or magnitude ranges. It also provides support for querying individual earthquake records for detailed event information such as the event's depth, Did You Feel It (DYFI) report counts, the type of magnitude was computed, Modified Mercalli Intensity (MMI), etc.

Historical Query Examples

Retrieve records of earthquake events between January 2, 2024 to January 3, 2024:

$ geteq fdsn query -t 2024-01-02,2024-01-03

Retrieve records with magnitude range between 4.5 to 7.5 and formatted to output JSON:

$ geteq fdsn q -m 4.5,7.5 -o json # q is an alias for query

Retrieve records with magnitudes greater than 4.5 and formatted to output CSV:

$ geteq fdsn q -m ">4.5" -o csv # NOTE: quotes are required

Retrieve records with magnitudes less than 0.5 for one day formatted to JSON and then piped (|) to the json.tool Python module to "pretty print" to the terminal:

# NOTE that the quotes are required for bounded magnitude searches
$ geteq fdsn q -m "<0.5" -t 2024-02-05,2024-02-06 -o json | python3 -m json.tool

Retrieve details of a single event using an eventid:

$ geteq fdsn query event uw10530748 # where uw10530748 is an eventid
$ geteq fdsn q e uw10530748 # where e is an alias for event

About

Access earthquake event records from the terminal

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages