The GIPPtools software utilities aid with initial pre-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, there is absolutely no reason why the utilities should not 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 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
There are two requirements that must be met before you can use the programs in the GIPPtools package:
-
A working Java virtual machine (also called a Java Runtime Environment or simply JRE) supporting Java 8 or newer!
-
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!
Usually, it is the best to just use the Java distribution that come with
your operating system. Check with your package manager for up-to-date
Java packages and if necessary install them. Alternatively, you can just manually download and install a JRE yourself, e.g. from the AdoptOpenJDK site. |
Installation
To start with the GIPPtools, you can either just download one of the ready-made binary distributions OR manually build the whole release yourself.
Binary Download
Currently, there are two binary distributions 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 Releases subpage of this repository.
The main difference between the two distributions is the start script used to run the various GIPPtool programs. Apart from that they are functionally identical.
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.
The GIPPtools Windows release is published as ZIP file, which should
unzip by double-clicking on the icon.
|
Build GIPPtools
The GIPPtools project uses Git to manage the source code, and the Gradle build tool. You might want to familiarize yourself with these tools. But building a GIPPtools release usually boils down to the following steps:
-
Obtain the source code. (Either use Git to clone the repository or just download a source archive from the webpage.)
-
Change into the created GIPPtools directory.
-
Use Gradle to build everything.
The following is a very minimal example of the necessary commands:
git clone https://git.gfz-potsdam.de/gipp/gipptools.git cd gipptools ./gradlew clean build
After successfully building the project, you will find the freshly compiled
installation files in the build/distributions
subdirectory. Proceed with
the installation as usual.
You don’t need to install Gradle or a full Java Development Kit (JDK) manually. The third build step should automatically download everything required. However, you need a minimal JRE to start the provided Gradle wrapper. |
Documentation
Once installed, all documentation can be found inside the doc
subdirectory
of the GIPPtools installation directory. It is not fully developed yet, but
nevertheless should get you started.
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 contained in the documentation directory are some example files you might want to use as templates for your own projects.