Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 3.36 KB

index.rst

File metadata and controls

53 lines (37 loc) · 3.36 KB

Welcome to ImpDAR's documentation!

ImpDAR is a flexible, open-source impulse radar processor that provides most of the benefits (and some additional features) compared to expensive commercial software. The starting point was the old St. Olaf deep radar matlab code. This code has a lot of history of contributors--I've tried to preserve acknowledgment of many of them in the file headers.

Support is gradually being added for a variety of file formats. Currently, GSSI, PulseEKKO, Ramac, Blue Systems, DELORES, SEGY, gprMAX, Gecko, and legacy StoDeep files are supported. Additionally, there is support for the BAS ApRES systems (though the processing chain is separate and documentation is not yet complete). Available processing steps include various filtering operations, trivial modifications such as restacking, cropping, or reversing data, and a few different geolocation-related operations like interpolating to constant trace spacing. The primary interface is through the command line, which allows efficient processing of large volumes of data. An API, centered around the RadarData class, is also available to allow the user to use ImpDAR in other programs.

In addition to processing, ImpDAR can also be used for picking reflectors. Picking is generally an interactive process, and there is a light GUI for doing the picking. The GUI also provides support for basic processing operations, so you can see the effect of steps as you go along.

Requirements

Python 3.6+ (other versions may work but are untested), numpy, scipy, matplotlib, SegYIO, h5py.

To do anything involving geolocation, you will also need GDAL. The GUI, which is needed to be able to pick reflectors, requires PyQt5.

Examples

Check out the examples <\examples/index>, particularly the Jupyter notebook examples beginning with getting started <\ImpDAR_tutorials/getting_started/ImpDAR_GettingStarted>, for an idea of how to run ImpDAR. These should be a good starting point that can be modified for a particular use case. While all of the output and input are on this website, if you actually want to run the code you can download all the notebooks and run them yourself. You can get those here.

Contributing

I would be thrilled to get pull requests for any additional functionality. In particular, it is difficult for me to add support for input formats for which I do not have example data--any development of readers for additional data types would be greatly appreciated.

installation.rst lib/index.rst bin/index.rst examples/index.rst

Indices and tables

  • genindex
  • modindex
  • search