GIPPtools

A collection of software utilities that aid with initial pre-processing of recorded (seismic) data supporting users that borrow instruments from the GIPP.

1
contributor
499 commits | Last commit 2 weeks ago

Cite this software

What GIPPtools can do for you

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 Data Cube family of 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.

Requirements

Two requirements must be met before you can use the utilities of the GIPPtools package:

  1. A working Java virtual machine (also called a Java Runtime Environment or simply JRE) supporting Java 8 or newer!
    Hint: You can download and install a JRE from e.g. the Adoptium site if your operating system dos not already provide an adequate runtime.

  2. 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

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 Release subpage of the GitLab repository.
  • The Software section of the GIPP webpage.
  • Via the GIPPtools DOI.

Once downloaded and unpacked the GIPPtools are pretty much ready for use. The Install document inside the doc subdirectory contains more detailed instructions.

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. 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 the 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.

License

  • The source code and binaries of the GIPPtools project are made available under the terms of the Apache License Version 2.0.

  • Project documentation and other media files are license under the Creative Commons Attribution 4.0 International License.

Logo of GIPPtools
Keywords
Programming languages
  • Java 98%
  • Shell 2%
  • XSLT 0%
  • Batchfile 0%
License
</>Source code

Participating organisations

Helmholtz Centre Potsdam GFZ German Research Centre for Geosciences

Contributors

CL
Christof Lendl
Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences