UTDQuake / README.md
ecastillot's picture
Update README.md
c7b0dc5 verified
metadata
name: UTDQuake
description: University of Texas at Dallas Earthquake Dataset
tags:
  - seismology
  - earthquake
  - picks
  - AI
license: gpl-3.0
homepage: https://github.com/ecastillot/UTDQuake
configs:
  - config_name: 0_networks
    data_files:
      - split: metadata
        path: network/network.parquet
  - config_name: 1_stations
    data_files:
      - split: metadata
        path:
          - stations/network=AEIC.parquet
          - stations/network=AFAD.parquet
          - stations/network=ANF.parquet
          - stations/network=ATH.parquet
          - stations/network=AUST.parquet
          - stations/network=BEO.parquet
          - stations/network=BER.parquet
          - stations/network=BGS.parquet
          - stations/network=BUC.parquet
          - stations/network=BYKL.parquet
          - stations/network=CATAC.parquet
          - stations/network=CNRM.parquet
          - stations/network=DJA.parquet
          - stations/network=EAF.parquet
          - stations/network=ECX.parquet
          - stations/network=EST.parquet
          - stations/network=ETH.parquet
          - stations/network=FUNV.parquet
          - stations/network=GCG.parquet
          - stations/network=GEOFON.parquet
          - stations/network=GFZ.parquet
          - stations/network=GII.parquet
          - stations/network=HEL.parquet
          - stations/network=IDC.parquet
          - stations/network=IGQ.parquet
          - stations/network=INET.parquet
          - stations/network=INMG.parquet
          - stations/network=IPGP.parquet
          - stations/network=ISC.parquet
          - stations/network=ISK.parquet
          - stations/network=ISN.parquet
          - stations/network=JAPAN.parquet
          - stations/network=JSN.parquet
          - stations/network=KMA.parquet
          - stations/network=KNET.parquet
          - stations/network=KRNET.parquet
          - stations/network=KRSC.parquet
          - stations/network=KRSZO.parquet
          - stations/network=LDG.parquet
          - stations/network=MDD.parquet
          - stations/network=MEX.parquet
          - stations/network=MRB.parquet
          - stations/network=NIC.parquet
          - stations/network=NNC.parquet
          - stations/network=NOA.parquet
          - stations/network=NOU.parquet
          - stations/network=OSPL.parquet
          - stations/network=OTT.parquet
          - stations/network=PDG.parquet
          - stations/network=PRE.parquet
          - stations/network=RHSSO.parquet
          - stations/network=RSNC.parquet
          - stations/network=RSPR.parquet
          - stations/network=SJA.parquet
          - stations/network=TAP.parquet
          - stations/network=THE.parquet
          - stations/network=TIR.parquet
          - stations/network=TUN.parquet
          - stations/network=UCC.parquet
          - stations/network=UCR.parquet
          - stations/network=UPA.parquet
          - stations/network=UPP.parquet
          - stations/network=USP.parquet
          - stations/network=VAO.parquet
          - stations/network=VIE.parquet
          - stations/network=ZUR.parquet
          - stations/network=admin.parquet
          - stations/network=ak.parquet
          - stations/network=at.parquet
          - stations/network=av.parquet
          - stations/network=hv.parquet
          - stations/network=mb.parquet
          - stations/network=nc.parquet
          - stations/network=nm.parquet
          - stations/network=nn.parquet
          - stations/network=ok.parquet
          - stations/network=pr.parquet
          - stations/network=se.parquet
          - stations/network=tx.parquet
          - stations/network=us.parquet
          - stations/network=uu.parquet
          - stations/network=uw.parquet
  - config_name: 2_events
    data_files:
      - split: metadata
        path:
          - events/network=AEIC.parquet
          - events/network=AFAD.parquet
          - events/network=ANF.parquet
          - events/network=ATH.parquet
          - events/network=AUST.parquet
          - events/network=BEO.parquet
          - events/network=BER.parquet
          - events/network=BGS.parquet
          - events/network=BUC.parquet
          - events/network=BYKL.parquet
          - events/network=CATAC.parquet
          - events/network=CNRM.parquet
          - events/network=DJA.parquet
          - events/network=EAF.parquet
          - events/network=ECX.parquet
          - events/network=EST.parquet
          - events/network=ETH.parquet
          - events/network=FUNV.parquet
          - events/network=GCG.parquet
          - events/network=GEOFON.parquet
          - events/network=GFZ.parquet
          - events/network=GII.parquet
          - events/network=HEL.parquet
          - events/network=IDC.parquet
          - events/network=IGQ.parquet
          - events/network=INET.parquet
          - events/network=INMG.parquet
          - events/network=IPGP.parquet
          - events/network=ISC.parquet
          - events/network=ISK.parquet
          - events/network=ISN.parquet
          - events/network=JAPAN.parquet
          - events/network=JSN.parquet
          - events/network=KMA.parquet
          - events/network=KNET.parquet
          - events/network=KRNET.parquet
          - events/network=KRSC.parquet
          - events/network=KRSZO.parquet
          - events/network=LDG.parquet
          - events/network=MDD.parquet
          - events/network=MEX.parquet
          - events/network=MRB.parquet
          - events/network=NIC.parquet
          - events/network=NNC.parquet
          - events/network=NOA.parquet
          - events/network=NOU.parquet
          - events/network=OSPL.parquet
          - events/network=OTT.parquet
          - events/network=PDG.parquet
          - events/network=PRE.parquet
          - events/network=RHSSO.parquet
          - events/network=RSNC.parquet
          - events/network=RSPR.parquet
          - events/network=SJA.parquet
          - events/network=TAP.parquet
          - events/network=THE.parquet
          - events/network=TIR.parquet
          - events/network=TUN.parquet
          - events/network=UCC.parquet
          - events/network=UCR.parquet
          - events/network=UPA.parquet
          - events/network=UPP.parquet
          - events/network=USP.parquet
          - events/network=VAO.parquet
          - events/network=VIE.parquet
          - events/network=ZUR.parquet
          - events/network=admin.parquet
          - events/network=ak.parquet
          - events/network=at.parquet
          - events/network=av.parquet
          - events/network=hv.parquet
          - events/network=mb.parquet
          - events/network=nc.parquet
          - events/network=nm.parquet
          - events/network=nn.parquet
          - events/network=ok.parquet
          - events/network=pr.parquet
          - events/network=se.parquet
          - events/network=tx.parquet
          - events/network=us.parquet
          - events/network=uu.parquet
          - events/network=uw.parquet
  - config_name: 3_picks
    data_files:
      - split: metadata
        path:
          - picks/network=AEIC.parquet
          - picks/network=AFAD.parquet
          - picks/network=ANF.parquet
          - picks/network=ATH.parquet
          - picks/network=AUST.parquet
          - picks/network=BEO.parquet
          - picks/network=BER.parquet
          - picks/network=BGS.parquet
          - picks/network=BUC.parquet
          - picks/network=BYKL.parquet
          - picks/network=CATAC.parquet
          - picks/network=CNRM.parquet
          - picks/network=DJA.parquet
          - picks/network=EAF.parquet
          - picks/network=ECX.parquet
          - picks/network=EST.parquet
          - picks/network=ETH.parquet
          - picks/network=FUNV.parquet
          - picks/network=GCG.parquet
          - picks/network=GEOFON.parquet
          - picks/network=GFZ.parquet
          - picks/network=GII.parquet
          - picks/network=HEL.parquet
          - picks/network=IDC.parquet
          - picks/network=IGQ.parquet
          - picks/network=INET.parquet
          - picks/network=INMG.parquet
          - picks/network=IPGP.parquet
          - picks/network=ISC.parquet
          - picks/network=ISK.parquet
          - picks/network=ISN.parquet
          - picks/network=JAPAN.parquet
          - picks/network=JSN.parquet
          - picks/network=KMA.parquet
          - picks/network=KNET.parquet
          - picks/network=KRNET.parquet
          - picks/network=KRSC.parquet
          - picks/network=KRSZO.parquet
          - picks/network=LDG.parquet
          - picks/network=MDD.parquet
          - picks/network=MEX.parquet
          - picks/network=MRB.parquet
          - picks/network=NIC.parquet
          - picks/network=NNC.parquet
          - picks/network=NOA.parquet
          - picks/network=NOU.parquet
          - picks/network=OSPL.parquet
          - picks/network=OTT.parquet
          - picks/network=PDG.parquet
          - picks/network=PRE.parquet
          - picks/network=RHSSO.parquet
          - picks/network=RSNC.parquet
          - picks/network=RSPR.parquet
          - picks/network=SJA.parquet
          - picks/network=TAP.parquet
          - picks/network=THE.parquet
          - picks/network=TIR.parquet
          - picks/network=TUN.parquet
          - picks/network=UCC.parquet
          - picks/network=UCR.parquet
          - picks/network=UPA.parquet
          - picks/network=UPP.parquet
          - picks/network=USP.parquet
          - picks/network=VAO.parquet
          - picks/network=VIE.parquet
          - picks/network=ZUR.parquet
          - picks/network=admin.parquet
          - picks/network=ak.parquet
          - picks/network=at.parquet
          - picks/network=av.parquet
          - picks/network=hv.parquet
          - picks/network=mb.parquet
          - picks/network=nc.parquet
          - picks/network=nm.parquet
          - picks/network=nn.parquet
          - picks/network=ok.parquet
          - picks/network=pr.parquet
          - picks/network=se.parquet
          - picks/network=tx.parquet
          - picks/network=us.parquet
          - picks/network=uu.parquet
          - picks/network=uw.parquet

UTDQuake

University of Texas at Dallas Earthquake Dataset

Installation (utdquake)

pip install utdquake==0.1

Documentation

Full documentation for UTDQuake is available here:

Read the Docs

You will see:

  • QuickStart guide to get you up and running
  • Detailed API reference
  • Tutorials and example workflows

Dataset

Why this dataset matters?

Curated datasets of earthquake events and phase picks are essential for modern seismology, especially in the AI era. While waveform datasets have advanced earthquake detection, multistation picks provide complementary information crucial for phase association and earthquake location.

This dataset offers structured event catalogs, station metadata, and phase picks across networks, supporting reproducible research and the development of data-driven seismological methods.

What’s inside?

Directory Format Description
network/ *.parquet Network metadata.
events/ *.parquet Earthquake event catalogs per network.
stations/ *.parquet Station metadata per network.
picks/ *.parquet Seismic phase pick datasets per network.
bank/ *.zip ObsPlus EventBank datasets, one per network. Can be read directly using ObsPlus EventBank.

For details on the contents and schema of each dataset, please refer to the Hugging Face dataset viewer.

To get started, see the Quick Start section below, or click “Use this dataset” on the Hugging Face dataset page for example loading code.

Quick start

Basic Access

import utdquake as utdq

# dataset overview 
dataset = utdq.Dataset()
print(dataset)

# network level
network_data = dataset.networks
print(network_data)

dataset.plot_overview(savepath="utdquake.png")

Network Data

# load network 
network = dataset.get_network(name="tx")
print(network)

# events
events = network.events
print(events)

# stations
stations = network.stations
print(stations)

# picks
picks = network.picks
print(picks)

Event Bank

Check ObsPlus EventBank for more details.

# get event bank
ebank = network.bank # 

# Example: Filter by event_id
ev_ids = events["event_id"].iloc[:5].tolist()
cat = ebank.get_events(event_id=ev_ids)
print(cat)

# Example 2: Other filter (check obsplus.EventBank for more details)
cat2 = ebank.get_events(minmagnitude=4.3)
print(cat2)

Plot

# get Obspy Event
network = dataset.get_network(name="tx")
network.plot_overview(savepath="overview.png")
network.plot_uncertainty_boxplots(savepath="uncertainty_boxplots.png")
network.plot_station_location_uncertainty(savepath="station_location_uncertainty.png")
network.plot_stats(savepath="stats.png")
network.plot_pick_histograms(savepath="histograms.png")
network.plot_pick_stats(savepath="pick_stats.png")

Thanks

Thanks to the UT Dallas HPC team for providing the computational resources for this dataset.

We also thank the seismology and AI communities for their work in earthquake research, and Hugging Face for hosting and sharing open datasets.

We welcome feedback and contributions!

Authors


license: gpl-3.0