# CREDIT-X1local：A reference dataset for machine learning seismology from ChinArray in southwest China

-----------------------------------------
----------------------------------------
 
### Last Update in the Dataset:
July 26, 2023

### Reporting Bugs:
Report bugs please send me an email: luli@cea-igp.ac.cn

-------------------------------------

### Reference:
Li L, Wang WT Yu ZY and Chen YN(2023), CREDIT-X1local：A reference dataset for machine learning seismology from ChinArray in southwest China,. Earthq Sci 36 doi: 10.1016/j.eqs.2023.08.001
Yu ZY, Wang WT and Chen YN (2023). Benchmark on the accuracy and efficiency of several neural network based phase pickers using datasets from China Seismic Network. Earthq Sci 36(2): 113–131, doi:  10.1016/j.eqs.2022.10.001
-------------------------------------

The Python script “readh5.py” can be used to read and plot waveforms and labels for the earthquake selected by event_id. After running the script, all the labels of the selected earthquake are shown as follows. The detailed discriptions of waveform retrieving mode and attribute format in the dataset can be found in Text S2 of Supplementary Material of the aforementioned reference.

### Labels and brief discription.
event_id:YN.201103130305.0001                       #Event ID (Beijing time, NET.YYYYMMDDHHMM.DDDD).
  event_depth_km:5.0                                #Event depth (km). If there is no depth recorded, we set it to be -1.0. 
  event_latitude:25.778                             #Event latitude.
  event_longitude:100.356                           #Event longitude.
  event_magnitude:2.1                               #Event magnitude.
  event_origin_time:2011/03/12 19:05:58.730000      #Event origin time (UTC time, year/month/day hour:minute:second).
  event_type:eq                                     #Event type (eq:earthquake).
  station_id:X1.53042.01                            #Station ID (NET.STA.LOC)
    BHE:                                            #Station component name (BH:broadband, E:east-west, N:north-south, Z:vertical).
      delta_sec:0.01                                #Sampling rate (second).
      start_time:2011/03/12 19:04:26.235000         #Starting time of waveform.
      waveform_length_sample:20581                  #Number of sample points of waveform.
    BHN:
      delta_sec:0.01
      start_time:2011/03/12 19:04:26.235000
      waveform_length_sample:20581
    BHZ:
      delta_sec:0.01
      start_time:2011/03/12 19:04:26.235000
      waveform_length_sample:20581
    MANUAL.POLARITY.Pg:2011/03/12 19:06:06.276000   #Arrival time of Pg phase with P-wave first-motion polarity.
    MANUAL.POLARITY.Pg.CLARITY:I                    #CLARITY: Feature of first-motion (I:clear, E:flat, NULL:no label).
    MANUAL.POLARITY.Pg.UPDOWN:U                     #UPDOWN: Direction of first-motion (U:upward, R:downward, NULL:no label).
    MANUAL.POLARITY.Pg.back_azimuth_deg:49.0        #back_azimuth_deg: Back azimuth from station location to earthquake epicenter.
    MANUAL.POLARITY.Pg.dist_km:48.7                 #dist_km: Epicentral distance (km).
    MANUAL.POLARITY.Pg.mag:2.1                      #mag: Magnitude of the corresponding earthquake.
    MANUAL.POLARITY.Pg.type:MANUAL.POLARITY.Pg
    MANUAL.TRAVTIME.Pg:2011/03/12 19:06:06.276000   #Arrival time of phase (PickType.TRAVTIME.PhaseType).
                                                    #PickType: MANUAL:manual pick, RNN:automatic pick with rnn model.
                                                    #PhaseType: Kinds of phases, including Pg, Pn, Sg, Sn.
    MANUAL.TRAVTIME.Pg.RMS:0.06                     #RMS: Residual between manually picked and theoretical arrival times of phase (none:no residual for automatic pick).
    MANUAL.TRAVTIME.Pg.WT:1.0                       #WT: Weight of picked phase (none:no residual for automatic pick).
    MANUAL.TRAVTIME.Pg.back_azimuth_deg:49.0
    MANUAL.TRAVTIME.Pg.dist_km:48.7
    MANUAL.TRAVTIME.Pg.mag:2.1
    MANUAL.TRAVTIME.Pg.type:MANUAL.TRAVTIME.Pg
    MANUAL.TRAVTIME.Sg:2011/03/12 19:06:12.036000
    MANUAL.TRAVTIME.Sg.RMS:-0.11
    MANUAL.TRAVTIME.Sg.WT:1.0
    MANUAL.TRAVTIME.Sg.back_azimuth_deg:49.0
    MANUAL.TRAVTIME.Sg.dist_km:48.7
    MANUAL.TRAVTIME.Sg.mag:2.1
    MANUAL.TRAVTIME.Sg.type:MANUAL.TRAVTIME.Sg
    RNN.TRAVTIME.Pg:2011/03/12 19:06:06.235000
    RNN.TRAVTIME.Pg.RMS:none
    RNN.TRAVTIME.Pg.WT:none
    RNN.TRAVTIME.Pg.back_azimuth_deg:229.25
    RNN.TRAVTIME.Pg.dist_km:49.0
    RNN.TRAVTIME.Pg.mag:2.1
    RNN.TRAVTIME.Pg.tag:Y
    RNN.TRAVTIME.Pg.type:RNN.TRAVTIME.Pg
    RNN.TRAVTIME.Sg:2011/03/12 19:06:11.985000
    RNN.TRAVTIME.Sg.RMS:none
    RNN.TRAVTIME.Sg.WT:none
    RNN.TRAVTIME.Sg.back_azimuth_deg:229.25
    RNN.TRAVTIME.Sg.dist_km:49.0
    RNN.TRAVTIME.Sg.mag:2.1
    RNN.TRAVTIME.Sg.tag:Y                           #tag: Label to distinguish whether the pick is valid after epicenter distance constraint (Y:valid, N:not valid).
    RNN.TRAVTIME.Sg.type:RNN.TRAVTIME.Sg
    station_elevation_m:1435.0                      #Station elevation (m).
    station_latitude:25.4893                        #Station latitude.
    station_longitude:99.9868                       #Station longitude.
    types:MANUAL.POLARITY.Pg,RNN.TRAVTIME.Pg,RNN.TRAVTIME.Sg,MANUAL.TRAVTIME.Pg,MANUAL.TRAVTIME.Sg


Here we only show the attributes of one station for example. The attributes of all the stations related to the selected earthquake will be shown after running script “readh5.py”.