CLI tool to fetch and analyze earthquake data from USGS
Project description
Quake Analyzer
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.
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
git clone https://github.com/danielhaim1/quake-analyzer.git
cd quake-analyzer
pip install -e .
Dependencies
This project relies on the following major Python libraries:
- pandas for data manipulation and analysis.
- requests for fetching data from the USGS API.
- matplotlib for plotting data (optional, used with the
--plotflag).
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
--exportis 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
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file quake_analyzer-0.0.7.tar.gz.
File metadata
- Download URL: quake_analyzer-0.0.7.tar.gz
- Upload date:
- Size: 10.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5877b21558e0ab034728b0da004a76661db10a554e6d9f4c43eafdb1caf4b8e4
|
|
| MD5 |
64c295c6b7ad9f0c9b7d3252ed3b35c0
|
|
| BLAKE2b-256 |
849f6297c9331cc51736e8a82474cdd35c9a8bead8222fa6debd4263ce95b055
|
Provenance
The following attestation bundles were made for quake_analyzer-0.0.7.tar.gz:
Publisher:
publish.yml on danielhaim1/quake-analyzer
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
quake_analyzer-0.0.7.tar.gz -
Subject digest:
5877b21558e0ab034728b0da004a76661db10a554e6d9f4c43eafdb1caf4b8e4 - Sigstore transparency entry: 199323595
- Sigstore integration time:
-
Permalink:
danielhaim1/quake-analyzer@e45d7de56a5b1643e92d72e9b14491335beea5f2 -
Branch / Tag:
refs/tags/v0.0.7 - Owner: https://github.com/danielhaim1
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@e45d7de56a5b1643e92d72e9b14491335beea5f2 -
Trigger Event:
release
-
Statement type:
File details
Details for the file quake_analyzer-0.0.7-py3-none-any.whl.
File metadata
- Download URL: quake_analyzer-0.0.7-py3-none-any.whl
- Upload date:
- Size: 8.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
17c7ade8a7ec7f1646af0e1bcd753d77facc8074697b1fb0792a3efa96799304
|
|
| MD5 |
25e02f20be6f619b8149311a99c0c4e6
|
|
| BLAKE2b-256 |
6464b9525cc662becae3a80d3de022fedb731359148a7d2e5fcd6d4f840805a4
|
Provenance
The following attestation bundles were made for quake_analyzer-0.0.7-py3-none-any.whl:
Publisher:
publish.yml on danielhaim1/quake-analyzer
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
quake_analyzer-0.0.7-py3-none-any.whl -
Subject digest:
17c7ade8a7ec7f1646af0e1bcd753d77facc8074697b1fb0792a3efa96799304 - Sigstore transparency entry: 199323597
- Sigstore integration time:
-
Permalink:
danielhaim1/quake-analyzer@e45d7de56a5b1643e92d72e9b14491335beea5f2 -
Branch / Tag:
refs/tags/v0.0.7 - Owner: https://github.com/danielhaim1
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@e45d7de56a5b1643e92d72e9b14491335beea5f2 -
Trigger Event:
release
-
Statement type: