The GIPPtools software utilities aid with initial processing of recorded data supporting users that borrow instruments from the Geophysical Instrument Pool Potsdam (GIPP). All programs in the GIPPtools collection are designed to work with native files produced by DSS-Cube/Data-Cube3 recorders and with miniSEED files written by EDR-209/210 and PR6-24 Portable Field Recorder. However, the utilities should work with miniSEED or Cube files produced by other instruments or software as well!
The programs can help you to “manage” your recorded data and to prepare the dataset for import into whatever processing system you use for further scientific analysis. You can use the utilities, among other things, to convert, re-organize and cut out (seismic) data from miniSEED and Cube data files.
Utilities
The following programs are part of the GIPPtools collection:
cube2ascii |
Convert Cube recordings to various ASCII text formats. |
cube2mseed |
Convert Cube recordings to miniSEED format. |
cube2segy |
Convert Cube recordings to SEG-Y format. |
cubeevent |
List events captured by the Cube event recorder hardware. |
cubeinfo |
Inspect and summarize the content of Cube files. |
mseed2ascii |
Convert miniSEED files to various ASCII text formats. |
mseed2mseed |
Modify header fields of miniSEED records. |
mseed2pdas |
Convert miniSEED files to PDAS format. |
mseed2segy |
Convert miniSEED files to SEG-Y format. |
mseedcut |
Cut out data segments from miniSEED files. |
mseedinfo |
Inspect and summarize the content of miniSEED files. |
mseedrecover |
Recover miniSEED records from damaged files and disks. |
mseedrename |
Batch rename miniSEED files using a template. |
Requirements
Two requirements must be met before you can use the utilities of the GIPPtools package:
-
A working Java virtual machine (also called a Java Runtime Environment or simply JRE) supporting Java 8 or newer!
You can download and install a JRE from e.g. the Adoptium site if your operating system dos not already provide an adequate runtime. -
You need some console or terminal window on your computer where you can type commands. None of the GIPPtools programs utilizes a graphical user interface. They all take their parameters and options exclusively from the command line!
Installation
To get started with the GIPPtools, you can either just download a ready-made binary distribution OR you can manually build the release yourself.
Most people are probably fine with just using the ready-made distribution!
Ready-made Binary Distribution
Two binary distributions variants available. One is for Unix style operating systems such as Linux, macOS, Solaris, etc. The other one is for the Microsoft Windows family. You can download either one from the following locations:
The Unix distribution is provided as gzipped TAR archive file. Use
the gunzip program to decompress the archive and extract files
with the tar command afterwards.The GIPPtools Windows release is published as ZIP file, which should unzip by double-clicking on the icon. |
Once downloaded and unpacked the GIPPtools are pretty much ready for use. The Install document inside the doc subdirectory contains more detailed instructions.
Manual Build
For the steps necessary to manually build the GIPPtools, please refer to the BUILD document in the repository.
Documentation
Once the GIPPtools are installed, all documentation can be found inside the doc subdirectory of the installation directory. It is not fully developed yet, nevertheless should get you started.
While all documentation is available in HTML and PDF format,
the GIPPtools distribution for Unix operating systems contains an
additional copy of the documentation set, ready for display by the
standard Unix man command.
|
Also part of the documentation are some example files you might want to use as templates for your own projects.
Bug Reports or Feature Requests
If you encounter a bug, misfeature, or missing feature in GIPPtools, the preferred reporting method is by filing an issue in this GitLab repository.
Please do not hesitate to file a bug report, even if you think the problem is already known, or aren’t sure of the details. Just provide as much information as you have. It would be nice if you could also include the GIPPtools release number you are using as well as the computer platform you are running it on.
You should also file issues if the documentation is out of date or unclear.