Update README.md

README.md

@@ -1,82 +1,586 @@
----
-name: UTDQuake
-description: University of Texas at Dallas Earthquake Dataset
-tags:
-  - seismology
-  - earthquake
-license: gpl-3.0
-homepage: https://github.com/ecastillot/UTDQuake
----
-
-# <span style="background:#E87500; color:white; padding:2px 6px; border-radius:6px;">UTD</span>Quake
-University of Texas at Dallas Earthquake Dataset
-
-**Authors**
-- Emmanuel Castillo (edc240000@utdallas.edu)
-- Nadine Ushakov
-- Marine Denolle
-
-## What’s inside?
-
-- `events/` → zipped datasets per network (`*.zip`)
-- Each network contains event and pick information (when available)
-
-## Quick start
-
-### Access
-```python
-import utdquake as utdq
-
-# loads tx
-bank =  utdq.load_network("tx")   
-print(bank.stats)
-
-# read events information
-df = bank.read_index()    
-print(df.head())
-
-ev_ids = df["event_id"].tolist()[:5]
-picks = bank.get_picks(event_ids=ev_ids)
-print(picks)
-```
-
-### Catalog
-```python
-# get Obspy Catalog
-catalog = bank.get_events(starttime=UTCDateTime("2025-07-31T00:00:00"), 
-                            endtime=UTCDateTime("2025-07-31T12:00:00"))
-print(catalog)
-print(catalog.to_df())
-
-# get Obspy Event
-event = catalog[0]
-picks = event.picks_to_df()
-arrivals = event.arrivals_to_df()
-print(event,picks,arrivals)
-```
-
-### Picks db (Massive)
-```python
-# Save
-bank.save_picks()
-picks = bank.load_picks()
-print(picks)
-```
-
-### Plot
-```python
-# get Obspy Event
-bank.plot_overview("./overview.png")
-bank.plot_uncertainty_boxplots("./uncertainty_boxplots.png")
-bank.plot_station_location_uncertainty("./station_location_uncertainty.png")
-bank.plot_stats("./stats.png")
-bank.plot_pick_histograms("./histograms.png")
-bank.plot_pick_stats("./pick_stats.png")
-```
-
-
-
-
----
-license: gpl-3.0
----
+---
+name: UTDQuake
+description: University of Texas at Dallas Earthquake Dataset
+tags:
+  - seismology
+  - earthquake
+license: gpl-3.0
+homepage: https://github.com/ecastillot/UTDQuake
+configs:
+- config_name: 0_network
+  data_files:
+  - split: stats
+    path: manifests/stats.parquet
+- config_name: 1_stations
+  data_files:
+  - split: AEIC
+    path: manifests/stations/network=AEIC.parquet
+  - split: AFAD
+    path: manifests/stations/network=AFAD.parquet
+  - split: ANF
+    path: manifests/stations/network=ANF.parquet
+  - split: ATH
+    path: manifests/stations/network=ATH.parquet
+  - split: AUST
+    path: manifests/stations/network=AUST.parquet
+  - split: BEO
+    path: manifests/stations/network=BEO.parquet
+  - split: BER
+    path: manifests/stations/network=BER.parquet
+  - split: BGS
+    path: manifests/stations/network=BGS.parquet
+  - split: BUC
+    path: manifests/stations/network=BUC.parquet
+  - split: BYKL
+    path: manifests/stations/network=BYKL.parquet
+  - split: CATAC
+    path: manifests/stations/network=CATAC.parquet
+  - split: CNRM
+    path: manifests/stations/network=CNRM.parquet
+  - split: DJA
+    path: manifests/stations/network=DJA.parquet
+  - split: EAF
+    path: manifests/stations/network=EAF.parquet
+  - split: ECX
+    path: manifests/stations/network=ECX.parquet
+  - split: EST
+    path: manifests/stations/network=EST.parquet
+  - split: ETH
+    path: manifests/stations/network=ETH.parquet
+  - split: FUNV
+    path: manifests/stations/network=FUNV.parquet
+  - split: GCG
+    path: manifests/stations/network=GCG.parquet
+  - split: GEOFON
+    path: manifests/stations/network=GEOFON.parquet
+  - split: GFZ
+    path: manifests/stations/network=GFZ.parquet
+  - split: GII
+    path: manifests/stations/network=GII.parquet
+  - split: HEL
+    path: manifests/stations/network=HEL.parquet
+  - split: IDC
+    path: manifests/stations/network=IDC.parquet
+  - split: IGQ
+    path: manifests/stations/network=IGQ.parquet
+  - split: INET
+    path: manifests/stations/network=INET.parquet
+  - split: INMG
+    path: manifests/stations/network=INMG.parquet
+  - split: IPGP
+    path: manifests/stations/network=IPGP.parquet
+  - split: ISC
+    path: manifests/stations/network=ISC.parquet
+  - split: ISK
+    path: manifests/stations/network=ISK.parquet
+  - split: ISN
+    path: manifests/stations/network=ISN.parquet
+  - split: JAPAN
+    path: manifests/stations/network=JAPAN.parquet
+  - split: JSN
+    path: manifests/stations/network=JSN.parquet
+  - split: KMA
+    path: manifests/stations/network=KMA.parquet
+  - split: KNET
+    path: manifests/stations/network=KNET.parquet
+  - split: KRNET
+    path: manifests/stations/network=KRNET.parquet
+  - split: KRSC
+    path: manifests/stations/network=KRSC.parquet
+  - split: KRSZO
+    path: manifests/stations/network=KRSZO.parquet
+  - split: LDG
+    path: manifests/stations/network=LDG.parquet
+  - split: MDD
+    path: manifests/stations/network=MDD.parquet
+  - split: MEX
+    path: manifests/stations/network=MEX.parquet
+  - split: MRB
+    path: manifests/stations/network=MRB.parquet
+  - split: NIC
+    path: manifests/stations/network=NIC.parquet
+  - split: NNC
+    path: manifests/stations/network=NNC.parquet
+  - split: NOA
+    path: manifests/stations/network=NOA.parquet
+  - split: NOU
+    path: manifests/stations/network=NOU.parquet
+  - split: OSPL
+    path: manifests/stations/network=OSPL.parquet
+  - split: OTT
+    path: manifests/stations/network=OTT.parquet
+  - split: PDG
+    path: manifests/stations/network=PDG.parquet
+  - split: PRE
+    path: manifests/stations/network=PRE.parquet
+  - split: RHSSO
+    path: manifests/stations/network=RHSSO.parquet
+  - split: RSNC
+    path: manifests/stations/network=RSNC.parquet
+  - split: RSPR
+    path: manifests/stations/network=RSPR.parquet
+  - split: SJA
+    path: manifests/stations/network=SJA.parquet
+  - split: TAP
+    path: manifests/stations/network=TAP.parquet
+  - split: THE
+    path: manifests/stations/network=THE.parquet
+  - split: TIR
+    path: manifests/stations/network=TIR.parquet
+  - split: TUN
+    path: manifests/stations/network=TUN.parquet
+  - split: UCC
+    path: manifests/stations/network=UCC.parquet
+  - split: UCR
+    path: manifests/stations/network=UCR.parquet
+  - split: UPA
+    path: manifests/stations/network=UPA.parquet
+  - split: UPP
+    path: manifests/stations/network=UPP.parquet
+  - split: USP
+    path: manifests/stations/network=USP.parquet
+  - split: VAO
+    path: manifests/stations/network=VAO.parquet
+  - split: VIE
+    path: manifests/stations/network=VIE.parquet
+  - split: ZUR
+    path: manifests/stations/network=ZUR.parquet
+  - split: admin
+    path: manifests/stations/network=admin.parquet
+  - split: ak
+    path: manifests/stations/network=ak.parquet
+  - split: at
+    path: manifests/stations/network=at.parquet
+  - split: av
+    path: manifests/stations/network=av.parquet
+  - split: hv
+    path: manifests/stations/network=hv.parquet
+  - split: mb
+    path: manifests/stations/network=mb.parquet
+  - split: nc
+    path: manifests/stations/network=nc.parquet
+  - split: nm
+    path: manifests/stations/network=nm.parquet
+  - split: nn
+    path: manifests/stations/network=nn.parquet
+  - split: ok
+    path: manifests/stations/network=ok.parquet
+  - split: pr
+    path: manifests/stations/network=pr.parquet
+  - split: se
+    path: manifests/stations/network=se.parquet
+  - split: tx
+    path: manifests/stations/network=tx.parquet
+  - split: us
+    path: manifests/stations/network=us.parquet
+  - split: uu
+    path: manifests/stations/network=uu.parquet
+  - split: uw
+    path: manifests/stations/network=uw.parquet
+- config_name: 2_events
+  data_files:
+  - split: AEIC
+    path: manifests/events/network=AEIC.parquet
+  - split: AFAD
+    path: manifests/events/network=AFAD.parquet
+  - split: ANF
+    path: manifests/events/network=ANF.parquet
+  - split: ATH
+    path: manifests/events/network=ATH.parquet
+  - split: AUST
+    path: manifests/events/network=AUST.parquet
+  - split: BEO
+    path: manifests/events/network=BEO.parquet
+  - split: BER
+    path: manifests/events/network=BER.parquet
+  - split: BGS
+    path: manifests/events/network=BGS.parquet
+  - split: BUC
+    path: manifests/events/network=BUC.parquet
+  - split: BYKL
+    path: manifests/events/network=BYKL.parquet
+  - split: CATAC
+    path: manifests/events/network=CATAC.parquet
+  - split: CNRM
+    path: manifests/events/network=CNRM.parquet
+  - split: DJA
+    path: manifests/events/network=DJA.parquet
+  - split: EAF
+    path: manifests/events/network=EAF.parquet
+  - split: ECX
+    path: manifests/events/network=ECX.parquet
+  - split: EST
+    path: manifests/events/network=EST.parquet
+  - split: ETH
+    path: manifests/events/network=ETH.parquet
+  - split: FUNV
+    path: manifests/events/network=FUNV.parquet
+  - split: GCG
+    path: manifests/events/network=GCG.parquet
+  - split: GEOFON
+    path: manifests/events/network=GEOFON.parquet
+  - split: GFZ
+    path: manifests/events/network=GFZ.parquet
+  - split: GII
+    path: manifests/events/network=GII.parquet
+  - split: HEL
+    path: manifests/events/network=HEL.parquet
+  - split: IDC
+    path: manifests/events/network=IDC.parquet
+  - split: IGQ
+    path: manifests/events/network=IGQ.parquet
+  - split: INET
+    path: manifests/events/network=INET.parquet
+  - split: INMG
+    path: manifests/events/network=INMG.parquet
+  - split: IPGP
+    path: manifests/events/network=IPGP.parquet
+  - split: ISC
+    path: manifests/events/network=ISC.parquet
+  - split: ISK
+    path: manifests/events/network=ISK.parquet
+  - split: ISN
+    path: manifests/events/network=ISN.parquet
+  - split: JAPAN
+    path: manifests/events/network=JAPAN.parquet
+  - split: JSN
+    path: manifests/events/network=JSN.parquet
+  - split: KMA
+    path: manifests/events/network=KMA.parquet
+  - split: KNET
+    path: manifests/events/network=KNET.parquet
+  - split: KRNET
+    path: manifests/events/network=KRNET.parquet
+  - split: KRSC
+    path: manifests/events/network=KRSC.parquet
+  - split: KRSZO
+    path: manifests/events/network=KRSZO.parquet
+  - split: LDG
+    path: manifests/events/network=LDG.parquet
+  - split: MDD
+    path: manifests/events/network=MDD.parquet
+  - split: MEX
+    path: manifests/events/network=MEX.parquet
+  - split: MRB
+    path: manifests/events/network=MRB.parquet
+  - split: NIC
+    path: manifests/events/network=NIC.parquet
+  - split: NNC
+    path: manifests/events/network=NNC.parquet
+  - split: NOA
+    path: manifests/events/network=NOA.parquet
+  - split: NOU
+    path: manifests/events/network=NOU.parquet
+  - split: OSPL
+    path: manifests/events/network=OSPL.parquet
+  - split: OTT
+    path: manifests/events/network=OTT.parquet
+  - split: PDG
+    path: manifests/events/network=PDG.parquet
+  - split: PRE
+    path: manifests/events/network=PRE.parquet
+  - split: RHSSO
+    path: manifests/events/network=RHSSO.parquet
+  - split: RSNC
+    path: manifests/events/network=RSNC.parquet
+  - split: RSPR
+    path: manifests/events/network=RSPR.parquet
+  - split: SJA
+    path: manifests/events/network=SJA.parquet
+  - split: TAP
+    path: manifests/events/network=TAP.parquet
+  - split: THE
+    path: manifests/events/network=THE.parquet
+  - split: TIR
+    path: manifests/events/network=TIR.parquet
+  - split: TUN
+    path: manifests/events/network=TUN.parquet
+  - split: UCC
+    path: manifests/events/network=UCC.parquet
+  - split: UCR
+    path: manifests/events/network=UCR.parquet
+  - split: UPA
+    path: manifests/events/network=UPA.parquet
+  - split: UPP
+    path: manifests/events/network=UPP.parquet
+  - split: USP
+    path: manifests/events/network=USP.parquet
+  - split: VAO
+    path: manifests/events/network=VAO.parquet
+  - split: VIE
+    path: manifests/events/network=VIE.parquet
+  - split: ZUR
+    path: manifests/events/network=ZUR.parquet
+  - split: admin
+    path: manifests/events/network=admin.parquet
+  - split: ak
+    path: manifests/events/network=ak.parquet
+  - split: at
+    path: manifests/events/network=at.parquet
+  - split: av
+    path: manifests/events/network=av.parquet
+  - split: hv
+    path: manifests/events/network=hv.parquet
+  - split: mb
+    path: manifests/events/network=mb.parquet
+  - split: nc
+    path: manifests/events/network=nc.parquet
+  - split: nm
+    path: manifests/events/network=nm.parquet
+  - split: nn
+    path: manifests/events/network=nn.parquet
+  - split: ok
+    path: manifests/events/network=ok.parquet
+  - split: pr
+    path: manifests/events/network=pr.parquet
+  - split: se
+    path: manifests/events/network=se.parquet
+  - split: tx
+    path: manifests/events/network=tx.parquet
+  - split: us
+    path: manifests/events/network=us.parquet
+  - split: uu
+    path: manifests/events/network=uu.parquet
+  - split: uw
+    path: manifests/events/network=uw.parquet
+- config_name: 3_picks
+  data_files:
+  - split: AEIC
+    path: manifests/picks/network=AEIC.parquet
+  - split: AFAD
+    path: manifests/picks/network=AFAD.parquet
+  - split: ANF
+    path: manifests/picks/network=ANF.parquet
+  - split: ATH
+    path: manifests/picks/network=ATH.parquet
+  - split: AUST
+    path: manifests/picks/network=AUST.parquet
+  - split: BEO
+    path: manifests/picks/network=BEO.parquet
+  - split: BER
+    path: manifests/picks/network=BER.parquet
+  - split: BGS
+    path: manifests/picks/network=BGS.parquet
+  - split: BUC
+    path: manifests/picks/network=BUC.parquet
+  - split: BYKL
+    path: manifests/picks/network=BYKL.parquet
+  - split: CATAC
+    path: manifests/picks/network=CATAC.parquet
+  - split: CNRM
+    path: manifests/picks/network=CNRM.parquet
+  - split: DJA
+    path: manifests/picks/network=DJA.parquet
+  - split: EAF
+    path: manifests/picks/network=EAF.parquet
+  - split: ECX
+    path: manifests/picks/network=ECX.parquet
+  - split: EST
+    path: manifests/picks/network=EST.parquet
+  - split: ETH
+    path: manifests/picks/network=ETH.parquet
+  - split: FUNV
+    path: manifests/picks/network=FUNV.parquet
+  - split: GCG
+    path: manifests/picks/network=GCG.parquet
+  - split: GEOFON
+    path: manifests/picks/network=GEOFON.parquet
+  - split: GFZ
+    path: manifests/picks/network=GFZ.parquet
+  - split: GII
+    path: manifests/picks/network=GII.parquet
+  - split: HEL
+    path: manifests/picks/network=HEL.parquet
+  - split: IDC
+    path: manifests/picks/network=IDC.parquet
+  - split: IGQ
+    path: manifests/picks/network=IGQ.parquet
+  - split: INET
+    path: manifests/picks/network=INET.parquet
+  - split: INMG
+    path: manifests/picks/network=INMG.parquet
+  - split: IPGP
+    path: manifests/picks/network=IPGP.parquet
+  - split: ISC
+    path: manifests/picks/network=ISC.parquet
+  - split: ISK
+    path: manifests/picks/network=ISK.parquet
+  - split: ISN
+    path: manifests/picks/network=ISN.parquet
+  - split: JAPAN
+    path: manifests/picks/network=JAPAN.parquet
+  - split: JSN
+    path: manifests/picks/network=JSN.parquet
+  - split: KMA
+    path: manifests/picks/network=KMA.parquet
+  - split: KNET
+    path: manifests/picks/network=KNET.parquet
+  - split: KRNET
+    path: manifests/picks/network=KRNET.parquet
+  - split: KRSC
+    path: manifests/picks/network=KRSC.parquet
+  - split: KRSZO
+    path: manifests/picks/network=KRSZO.parquet
+  - split: LDG
+    path: manifests/picks/network=LDG.parquet
+  - split: MDD
+    path: manifests/picks/network=MDD.parquet
+  - split: MEX
+    path: manifests/picks/network=MEX.parquet
+  - split: MRB
+    path: manifests/picks/network=MRB.parquet
+  - split: NIC
+    path: manifests/picks/network=NIC.parquet
+  - split: NNC
+    path: manifests/picks/network=NNC.parquet
+  - split: NOA
+    path: manifests/picks/network=NOA.parquet
+  - split: NOU
+    path: manifests/picks/network=NOU.parquet
+  - split: OSPL
+    path: manifests/picks/network=OSPL.parquet
+  - split: OTT
+    path: manifests/picks/network=OTT.parquet
+  - split: PDG
+    path: manifests/picks/network=PDG.parquet
+  - split: PRE
+    path: manifests/picks/network=PRE.parquet
+  - split: RHSSO
+    path: manifests/picks/network=RHSSO.parquet
+  - split: RSNC
+    path: manifests/picks/network=RSNC.parquet
+  - split: RSPR
+    path: manifests/picks/network=RSPR.parquet
+  - split: SJA
+    path: manifests/picks/network=SJA.parquet
+  - split: TAP
+    path: manifests/picks/network=TAP.parquet
+  - split: THE
+    path: manifests/picks/network=THE.parquet
+  - split: TIR
+    path: manifests/picks/network=TIR.parquet
+  - split: TUN
+    path: manifests/picks/network=TUN.parquet
+  - split: UCC
+    path: manifests/picks/network=UCC.parquet
+  - split: UCR
+    path: manifests/picks/network=UCR.parquet
+  - split: UPA
+    path: manifests/picks/network=UPA.parquet
+  - split: UPP
+    path: manifests/picks/network=UPP.parquet
+  - split: USP
+    path: manifests/picks/network=USP.parquet
+  - split: VAO
+    path: manifests/picks/network=VAO.parquet
+  - split: VIE
+    path: manifests/picks/network=VIE.parquet
+  - split: ZUR
+    path: manifests/picks/network=ZUR.parquet
+  - split: admin
+    path: manifests/picks/network=admin.parquet
+  - split: ak
+    path: manifests/picks/network=ak.parquet
+  - split: at
+    path: manifests/picks/network=at.parquet
+  - split: av
+    path: manifests/picks/network=av.parquet
+  - split: hv
+    path: manifests/picks/network=hv.parquet
+  - split: mb
+    path: manifests/picks/network=mb.parquet
+  - split: nc
+    path: manifests/picks/network=nc.parquet
+  - split: nm
+    path: manifests/picks/network=nm.parquet
+  - split: nn
+    path: manifests/picks/network=nn.parquet
+  - split: ok
+    path: manifests/picks/network=ok.parquet
+  - split: pr
+    path: manifests/picks/network=pr.parquet
+  - split: se
+    path: manifests/picks/network=se.parquet
+  - split: tx
+    path: manifests/picks/network=tx.parquet
+  - split: us
+    path: manifests/picks/network=us.parquet
+  - split: uu
+    path: manifests/picks/network=uu.parquet
+  - split: uw
+    path: manifests/picks/network=uw.parquet
+
+---
+
+# <span style="background:#E87500; color:white; padding:2px 6px; border-radius:6px;">UTD</span>Quake
+University of Texas at Dallas Earthquake Dataset
+
+**Authors**
+- Emmanuel Castillo (edc240000@utdallas.edu)
+- Nadine Ushakov
+- Marine Denolle
+
+## What’s inside?
+
+- `events/` → zipped datasets per network (`*.zip`)
+- Each network contains event and pick information (when available)
+
+## Quick start
+
+### Access
+```python
+import utdquake as utdq
+
+# loads tx
+bank =  utdq.load_network("tx")   
+print(bank.stats)
+
+# read events information
+df = bank.read_index()    
+print(df.head())
+
+ev_ids = df["event_id"].tolist()[:5]
+picks = bank.get_picks(event_ids=ev_ids)
+print(picks)
+```
+
+### Catalog
+```python
+# get Obspy Catalog
+catalog = bank.get_events(starttime=UTCDateTime("2025-07-31T00:00:00"), 
+                            endtime=UTCDateTime("2025-07-31T12:00:00"))
+print(catalog)
+print(catalog.to_df())
+
+# get Obspy Event
+event = catalog[0]
+picks = event.picks_to_df()
+arrivals = event.arrivals_to_df()
+print(event,picks,arrivals)
+```
+
+### Picks db (Massive)
+```python
+# Save
+bank.save_picks()
+picks = bank.load_picks()
+print(picks)
+```
+
+### Plot
+```python
+# get Obspy Event
+bank.plot_overview("./overview.png")
+bank.plot_uncertainty_boxplots("./uncertainty_boxplots.png")
+bank.plot_station_location_uncertainty("./station_location_uncertainty.png")
+bank.plot_stats("./stats.png")
+bank.plot_pick_histograms("./histograms.png")
+bank.plot_pick_stats("./pick_stats.png")
+```
+
+
+
+
+---
+license: gpl-3.0
+---