-
Notifications
You must be signed in to change notification settings - Fork 9
PH5 Commands
hrotman-pic edited this page Sep 13, 2024
·
11 revisions
This page contains a complete list of PH5 commands. Alternatively, type ph5 in the terminal see a list of all PH5 commands.
Commands are executed by typing the name of a command & command options in the terminal. For example, to run ph5tostationxml a user would enter ph5tostationxml -n master -p /path/to/ph5-experiment on the command line.
- PH5 Editing and Manipulation
- PH5 Data and Metadata Ingestion
- PH5 Data and Metadata Extraction
- PH5 Data and Metadata QC
- Developers Tools
| Program | Description |
|---|---|
| fix_3chan_texan | A command line utility to read pre-loaded station information and produce a KEF file that corrects channel information in the das table where a texan is recording horizontal data. |
| fix_num_samples | Correct number of samples in time series array to work around a bug in certain data loggers. |
| index_offset_t | Index offset tables in master ph5 file to speed up searches. |
| kefedit | Edit, load, and extract kitchen exchange format (KEF) files to and from a family of ph5 files. BETA |
| load_das_t | A command line utility to load a batch of das table KEF files. |
| nuke_table | Re-initialize a selected table in a family of ph5 files. |
| set_deploy_pickup_times | A command line utility to set deploy and pickup times based on loaded time series data. |
| set_n_i_response | A command line utility to reference the correct response information where multiple families of ph5 files have been merged. |
| sort_recv_kef, sort_shot_kef | Sort an array table kef file or event table kef file by station or shot id. |
| unsimpleton | A command line utility to link Fairfield SEG-D file names that expose information about the contents of the file, ie. makes file names for carbon units. |
| Program | Description |
|---|---|
| 125atoph5 | A command line program to load RefTek texan 125a TRD files into a family of ph5 files. |
| 130toph5 | A command line program to load raw RefTek rt-130 data into a family of ph5 files. |
| geo_kef_gen | A command line program that calculates shot to receiver distances containing the sign from previously loaded station and shot geometries and produces a kitchen exchange format file (KEF). |
| graotoph5 | A command line program to load MSEED data into a family of ph5 files. Can also read using web services. |
| initialize_ph5 | Create an empty ph5 family of files. |
| keftoph5 | A command line program to load a KEF file into a family of ph5 files. |
| noven | Read in meta-data in csv format and perform initial quality control. Produces kitchen exchange format (KEF) files that can be loaded directly into a family of ph5 files. |
| pforma | Load raw data files into a family of ph5 files. Works with texan raw, rt-130 raw, and fairfield SEG-D files. Runs conversions in parallel to process largish data sets. To process a small data set use the command line programs |
| ph5_merge_helper | A utility program to aid merging multiple families of ph5 files possibly from multiple deployment and processing sites. DEPRECATED |
| recreate_external_references | Recreate external references in master ph5 file to time series data in external (mini) ph5 files from index of loaded data contained in master file. |
| reporttoph5 | Load a document (.pdf, .docx, .png, etc.) into the PH5 Report_g. Do not use, submit report files separately. |
| resp_load | Creates a CSV template for and loads RESP files into PH5 |
| seg2toph5 | A command line program to load SEG-2 files from Geometrics StrataVisors into a family of ph5 files. |
| segdtoph5 | A command line program to load Fairfield or SmartSolo nodal SEG-D files from 1-C and 3-C nodes into a family of ph5 files. |
| segytoph5 | A command line program to load SEG-Y data into a family of ph5 files. DEPRECATED. |
| sort_kef_gen | Create a cross reference KEF file between loaded time series data and station meta-data. |
| time_kef_gen | Calculate clock drift from texan data previously loaded into a family of ph5 files and produce a kitchen exchange format (KEF) file containing clock correction information. The KEF file can then be loaded directly into the family of ph5 files. |
| Program | Description |
|---|---|
| meta_data_gen | Extract meta-data in JSON format. |
| ph5toevt | Extract SEG-Y from a family of ph5 files in shot order. |
| ph5toexml | Extract event meta-data in Quakeml or EML. |
| ph5toms | Extract MSEED or SAC from a family of ph5 files. |
| ph5tostationxml | Extract station meta-data in stationXML or kml formats. |
| ph5torec | Extract SEG-Y from a family of ph5 files in receiver order. |
| ph5view | View data from a family of ph5 files in receiver or shot order and output as SEG-Y. DEPRECATED |
| Program | Description |
|---|---|
| cross_check_event_array_data | Attempts to cut data for each station and each shot and reports results. Used to find stations with missing data. |
| dumpsegd | Dump the headers from a Fairfield or SmartSolo SEG-D file. |
| dumpsegy | Dump the headers from a SEG-Y file. |
| dumpsac | Dump the headers from a SAC file. |
| keftokml | A command line utility to view station and event geometries in google earth using array and event KEF files. Produces KML files. |
| meta_data_gen | A command line utility to view meta-data from a family of ph5 files in JSON format. Provides options for selecting experiment, station, event, or loaded data info. |
| ph5tokef | A command line utility to dump select tables from a family of ph5 files to a KEF file. Can also be used to edit table data. |
| keftocsv | A command line utility used to convert a KEF file to CSV. |
| csvtokef | A command line utility used to convert a CSV file to KEF. |
| ph5_total | Report size of each member in a family of ph5 files. |
| ph5_validate | Runs set of QC checks on the PH5 archive. |
| ph5view | A program to view data in receiver or shot order from a family of ph5 files. Can produce SEG-Y as output. DEPRECATED |
| Program | Description |
|---|---|
| columns.py | Describes the ph5 file organization. |
| Experiment.py | Low level interface between ph5 and PyTables. |
| ph5API.py | Application programmers interface to read from ph5. Provides methods to read and manipulate data traces and meta-data from a ph5 family of files. |
| ph5utils.py | A collection of methods used with web services. |
| pn125.py | Read RefTek texan raw data files. |
| pn130.py | Read RefTek rt-130 raw data files. |
| SegdReader.py | Read Fairfield SEG-D Version 1.5-1 & 1.6 data files. |
| SegyReader.py | Read SEG-Y rev1 files. |