WIN2PhaseNet

May 6, 2025 · View on GitHub

Detailed usage for PhaseNet prediction

Key	Description
`data`	- continuous waveform data of one station - dataShape: (6000, 3) # means 60 seconds (100 Hz) / 3 component *2 - You can change data length with `--output_length` option.
`t0`	start time of waveform file
`sta_id`	station code

How to use

1. Input file preparation

continuous WIN waveform files
- format: WIN format
  For the detailed information, see https://wwweic.eri.u-tokyo.ac.jp/WIN/man.en/winformat.html
- Only 100 Hz data is acceptable.
- NIED provides 60 seconds of WIN waveform files.
  For the detailed information, see https://hinetwww11.bosai.go.jp/auth/download/cont/?LANG=en
- Make directory named WIN2PhaseNet/data and put the files there.
  You can change the path with --indir option.
channel table: correspondence Table of stations and their code
- format: txt format
  For the detailed information, see https://wwweic.eri.u-tokyo.ac.jp/WIN/man.ja/win.html (only in Japanese).
- Only support the following "component code (column [5])".
  -Vertical component: EW,E,X,VX
  -Horizontal component 1: NS,N,Y,VY
  -Horizontal component 2: UD,U,Z,VZ
- NIED provides channel table at the same time when downloading WIN waveform files.
  For the detailed information, see https://hinetwww11.bosai.go.jp/auth/download/cont/?LANG=en
- "Voltage amplification ratio (column [12])" is modified to the int value.
- Put the file as WIN2PhaseNet/etc/stn.tbl.
  You can change the path with --chtbl option.
(No need in case with --tbl2lst)station list: a list of stations to process
- format: txt format
- You can automatically set all the stations in the channel table as a station list with --tbl2lst option, instead of preparing a txt file of station list.
- Put the file as WIN2PhaseNet/etc/stn.lst.
  You can change the path with --stnlst option.
- sample: WIN2PhaseNet/sample/etc/stn.lst
(optional)rotation table: rotation coefficient table for S-net by Takagi et al. (2019).
- format: txt format
  Use WIN2PhaseNet/etc/ch_rot.takagi.
- You can change the path with --rottbl option.
(optional)filter configuration file: configuration file of band-pass filter by Saito (1974).
- format: txt format
  Row Description
  1 cut-off frequency (lower)
  2 cut-off frequency (higher)
  3 order of the filter
- Put the file as WIN2PhaseNet/etc/filter.prm.
  You can change the path with --filprm option.
- sample: WIN2PhaseNet/sample/etc/filter.prm

Row	Description
1	cut-off frequency (lower)
2	cut-off frequency (higher)
3	order of the filter

2. Configuration of WIN2PhaseNet

Set the following options at least.

Option	Description
`--mode {cont,train,test}`	specify the mode (See 'What is the output?' for the detailed infomation.)
`[--output_length OUTPUT_LENGTH]`	length of output npz waveform (unit: second, default: `60`, valid only for `cont` mode)
`[--tbl2lst]`	automatically set all the stations in the channel table as a station list
`[--rotation]`	add rotation process for S-net data
`[--filter]`	add band-pass filter process
`[--disable_winext]`	if set, do not check extention of WIN waveform files (default: checking enabled)
`[--winext WINEXT]`	extention of WIN waveform files (default: .cnt)

Use -h option for the detailed information of all other options.

3. Execute WIN2PhaseNet

# Pull docker image (only once), run the 'win2npz' container and then execute WIN2PhaseNet on the container environment. *3
# Stop and delete the container environment after execution is complete.
$ ./WIN2PhaseNet.bash --mode cont [--output_length OUTPUT_LENGTH] [--tbl2lst] [--rotation] [--filter] [--disable_winext] [--winext WINEXT]
# e.g. 
# $ ./WIN2PhaseNet.bash --mode cont # with both 'stn.lst' and 'stn.tbl'
# $ ./WIN2PhaseNet.bash --mode cont --tbl2lst # without 'stn.lst' (only 'stn.tbl')

# You can find the output of WIN2PhaseNet in 'WIN2PhaseNet/<OUTDIR(default: 'out')>' directory.

4. Execute PhaseNet prediction

This program NOT contains PhaseNet but show how to use PhaseNet briefly.
"npz waveform files" and "npz waveform list" made by cont mode of WIN2PhaseNet are required in advance.
Note that PhaseNet container runs with --security-opt seccomp:unconfined option.

# Clone PhaseNet and pull docker image at first. (only once) *3
# Run the 'phasenet' container and then execute PhaseNet on the container environment.
# Stop and delete the container environment after execution is complete.
$ ./PhaseNet.bash --model_dir=src/PhaseNet/model/190703-214543 --data_dir=<"npz waveform files" directory path of WIN2PhaseNet> --data_list=<"npz waveform list" path of WIN2PhaseNet> --amplitude --plot_figure
# e.g. 
# $ ./PhaseNet.bash --model_dir=src/PhaseNet/model/190703-214543 --data_dir=./out/npz --data_list=./out/npz.csv --amplitude --plot_figure

# You can find the output of PhaseNet in 'WIN2PhaseNet/results' directory.

Notes

*1 datetime: same information as t0 but format is "yymmddhhmmss"
station: same information as sta_id
*2 The following data is filled with 0.
- lack part when the data length of the input WIN waveform is less than the specified length (cont: [OUTPUT_LENGTH (default: 60)] seconds, train, test: 180 seconds)
- remainder when the data length of the input WIN waveform is not divisible by [OUTPUT_LENGTH (default: 60)] seconds (only cont mode)
*3 Each docker image is built from the following Dockerfile.
- win2npz: dockerfiles/win2npz/Dockerfile
- phasenet: dockerfiles/phasenet/Dockerfile