Skip to main content

CLI tool to fetch and analyze earthquake data from USGS

Project description

Quake Analyzer

License Python Version PyPI Version

quake-analyzer is a command-line tool that fetches and analyzes earthquake data, including filtering based on magnitude and location, calculating recurrence intervals, and generating reports. This tool can help researchers and enthusiasts analyze earthquake data from the USGS database over various timeframes.

Quake Analyzer Screenshot


Features

  • Fetch earthquake data from the USGS Earthquake API.
  • Filter earthquakes based on magnitude and region.
  • Analyze major earthquakes and their recurrence intervals.
  • Export the list to CSV.
  • Plot the count of major earthquakes per year.
  • Estimate the recurrence interval and probability of future major earthquakes.

Installation

From source

git clone https://github.com/danielhaim1/quake-analyzer.git
cd quake-analyzer
python3 -m venv venv
source venv/bin/activate
pip install -e .

From PyPI

pip install quake-analyzer

# Run the CLI help command to verify:
quake-analyzer --help
# Loading cities.csv...
# Loading countries.csv...
# Loading states.csv...

Dependencies

This project relies on the following major Python libraries:

  • pandas – for data manipulation and analysis.
  • numpy – for numerical calculations and averaging intervals.
  • requests – for fetching data from the USGS Earthquake API.
  • colorama – for colorful terminal output.
  • matplotlib – optional, used with the --plot flag to visualize earthquake trends.

Options

Option Description Default
--data Manually pass quakes as [[timestamp, magnitude, location], ...] None
--fetch Fetch recent earthquakes from USGS None
--minmag Minimum magnitude to filter 6.0
--days Number of days to look back from today 1825 (5 years)
--location Location name to filter by (supports city, state, or country from CSVs) None
--radius Radius in kilometers around the specified location None
--export Export results to CSV Off
--plot Plot earthquakes per year Off
--estimate Estimate the recurrence interval and probability of major quakes Off

Examples

Global major quakes in past 20 years

quake-analyzer --fetch --minmag 6.0 --days 7300

Estimate Next Quake

quake-analyzer --fetch --minmag 6.0 --days 7300 --estimate

Estimate Analysis (Colombia)

quake-analyzer --fetch --minmag 9.5 --location "Colombia" --radius 1000 --days 10000
quake-analyzer --fetch --minmag 8.5 --location "Colombia" --radius 1000 --days 10000
quake-analyzer --fetch --minmag 7.5 --location "Colombia" --radius 1000 --days 10000

Location based filtering

# Quakes near Tokyo (within 300 km)
quake-analyzer --fetch --location "Tokyo" --radius 300 --minmag 5.5 --days 3650

# California region, major quakes (last 20 years)
quake-analyzer --fetch --location "California" --radius 500 --minmag 6.0 --days 7300

# Chile, strong events only
quake-analyzer --fetch --location "Chile" --radius 400 --minmag 6.8 --days 7300

Custom manual input

# Manually analyze a couple of events
quake-analyzer --data "[['2021-12-01T12:00:00', 6.5, 'Tokyo'], ['2022-01-01T15:00:00', 7.0, 'Santiago']]"

Export and Plot

# Export filtered results to CSV
quake-analyzer --fetch --location "Alaska" --radius 500 --minmag 6.0 --days 3650 --export

# Plot quake frequency per year
quake-analyzer --fetch --location "Indonesia" --radius 500 --minmag 6.0 --days 7300 --plot

# Export and plot together
quake-analyzer --fetch --location "Mexico" --radius 300 --minmag 6.2 --days 5000 --export --plot

Location Resolution

You can pass --location using names of:

  • Cities (e.g., Tokyo, San Francisco)
  • States (e.g., California, Bavaria)
  • Countries (e.g., Japan, Mexico)

Coordinates are looked up from:

src/data/
├── cities.csv
├── states.csv
├── countries.csv

Each file should include:

name,latitude,longitude

Estimate: How It Works

The estimation feature calculates two important metrics based on recent earthquake data:

  • Recurrence Interval: The average time (in years) between major earthquakes (≥ 6.0 magnitude).
  • Probability: The likelihood of a major earthquake occurring within the next year.

Calculation Process::

  • Filter Major Quakes: Only earthquakes with a magnitude of 6.0 or higher are considered.
  • Calculate Time Intervals: The tool calculates the time differences between each consecutive major earthquake.
  • Compute Mean Recurrence Interval: The mean recurrence interval is the average of these time intervals.
  • Estimate Probability: The probability of a major earthquake occurring within the next year is estimated as the inverse of the mean recurrence interval (1 / mean recurrence interval).

Example:

quake-analyzer --fetch --location "Tokyo" --radius 300 --minmag 9.5 --days 20000 --estimate
quake-analyzer --fetch --location "Tokyo" --radius 300 --minmag 8.5 --days 20000 --estimate
quake-analyzer --fetch --location "Tokyo" --radius 300 --minmag 7.5 --days 20000 --estimate
  • Fetch earthquake data for Tokyo (within a 300 km radius).
  • Filter by magnitude ≥ 6.0.
  • Estimate the recurrence interval and probability based on the quakes in that region over the last 10 years (3650 days).

Outputs

The tool will output earthquake data in the terminal, including:

  • The total number of major earthquakes.

  • The years in which earthquakes occurred.

  • Gaps between major earthquakes.

  • A summary of earthquakes per year.

  • Estimates of recurrence intervals and probabilities (if --estimate is used).

  • If --export is used, the results will be saved to a CSV file with the following columns:

  • Years Ago

  • Magnitude

  • Date

  • Timestamp

  • Location

  • Type (Major or Moderate)

  • Mean Recurrence Interval (years)

  • Estimated Probability (per year)


Screenshots

Quake Analyzer Screenshot (Estimate) Quake Analyzer Screenshot (Estimate) Quake Analyzer Screenshot (Estimate) Quake Analyzer Screenshot (Estimate) Quake Analyzer Screenshot Quake Analyzer Screenshot Quake Analyzer Screenshot Quake Analyzer Screenshot Quake Analyzer Screenshot


Notes

  • USGS limits results to 20 years and 2000 entries per request.
  • For smaller magnitudes (e.g., 3.0+), results may be capped quickly, especially in active zones.
  • Timestamp columns in exported CSVs include both quake time and export time.
  • Plots require matplotlib. Install via:
pip install matplotlib

License

This project is licensed under the MIT License. See the LICENSE file for details.


Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.


Reporting Bugs

If you encounter a bug or issue, please open an issue on the GitHub repository with as much detail as possible including:

  • Command used
  • Stack trace or error message
  • Your OS and Python version

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

quake_analyzer-0.1.0.tar.gz (11.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

quake_analyzer-0.1.0-py3-none-any.whl (9.1 kB view details)

Uploaded Python 3

File details

Details for the file quake_analyzer-0.1.0.tar.gz.

File metadata

  • Download URL: quake_analyzer-0.1.0.tar.gz
  • Upload date:
  • Size: 11.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for quake_analyzer-0.1.0.tar.gz
Algorithm Hash digest
SHA256 af21b076112179dc7536300e23ed79ed3bf0b07df27a2e80470df209ed8d3bbd
MD5 56627462b68d6d188e57aad42b992a01
BLAKE2b-256 0dd364fb59043ab27d31a691c691b630830704ad94e0c274a193168ef8062172

See more details on using hashes here.

Provenance

The following attestation bundles were made for quake_analyzer-0.1.0.tar.gz:

Publisher: publish.yml on danielhaim1/quake-analyzer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file quake_analyzer-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: quake_analyzer-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 9.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for quake_analyzer-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 98dd8dde2d1874b16608498043367e6cffe0b86d8fea3fab31b92e96967e7f0c
MD5 c26fea78ede880dd36f17277648fd5c1
BLAKE2b-256 1345e1119b4bf053b0e3b2126bf4f1ae4531d0128ba6c28c27833635e31c9e52

See more details on using hashes here.

Provenance

The following attestation bundles were made for quake_analyzer-0.1.0-py3-none-any.whl:

Publisher: publish.yml on danielhaim1/quake-analyzer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page