Skip to main content

Speeding up Ground Penetrating Radar (GPR) processing

Project description

PyPI Crates.io CI

Ridal — Speeding up Ground Penetrating Radar (GPR) processing

The aim of ridal is to quickly and accurately process GPR data. In one command, most data can be processed in pre-set profiles or with custom filter settings, and batch modes allow for sequences of datasets to be processed with the same settings. Built in rust with a high focus on testing and performance, ridal may be for you if large data volumes and strange fileformats are common issues.

The name is a take on the loosely defined "Data Abstraction Library" (DAL) projects like GDAL and PDAL, but for radar. A near-term goal of Ridal is to enable easy translation between formats, such as ridal translate input.rad output.dzt (this is not yet implemented).

Much of the functionality has been inspired from the projects RGPR and ImpDAR; both of which are more mature projects. For example, Ridal currently only works on Malå (.rd3) and pulseEKKO (.dt1) radar formats. For many uses, these will more likely be the tools for you!

Prior to Feb. 2026, this program was called rsgpr.

Note on imminent interface change

The CLI/Python interface will soon change completely (0.5 or 0.6) and all code will need to be modified accordingly. See Issue #82 for more info.

Image of a glacier radargram Radargram (100 MHz Malå) of Kroppbreen in Svalbard. Collected 28 Feb. 2023.

Installation

Requirements

  • cargo(only for the CLI; not the python package). Easiest installed using rustup.
  • gdal (optional, for sampling heights from DEMs). For Debian or derivatives, this means gdal-bin.
  • proj (optional, for CRS support other than WGS84 UTM Zones). For Debian or derivatives, this means proj-bin.

Using cargo, the ridal CLI can be installed (after installing the requirements):

cargo install ridal

with nix, the flake can be used without worrying about the requirements above:

{
  inputs = {
    ridal.url = "github:erikmannerfelt/ridal";
  };
}

or in an ephemeral shell:

nix shell github:erikmannerfelt/ridal

Python

There's a very early implementation of a Python package, which will be expanded in the future:

pip install ridal

See scripts/render_kroppbreen.py for an example of how it can be used.

Simple CLI usage

See the help page of ridal for info on how to interact with the CLI:

ridal -h

To toggle useful information on a file, the -i or --info argument shows the metadata and a summary of the location data:

ridal -f DAT_001_A1.rd3 -i

Processing a file using the default processing profile:

ridal -f DAT_001_A1.rd3 --default

All processing steps are shown in the steps.md file.

The output will be a NetCDF file with the same name but an .nc suffix. By default, the output is saved in the same directory as the input. For more control, the output directory and/or filename can be controlled with -o or --output.

To process multiple files in "batch mode", provide a "glob" pattern as the filename. Optionally, for many sequential files, the --merge argument allows merging multiple files into one.

ridal -f "data/*.rd3" --merge "10 min" --default -o output/

A rudimentary profile renderer is available with the -r argument. This will be saved in the same location as the output file as a JPG if another filename is not given.

Papers using Ridal

... and many others in preparation/review

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ridal-0.4.7.tar.gz (602.0 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

ridal-0.4.7-cp313-cp313-win_amd64.whl (4.5 MB view details)

Uploaded CPython 3.13Windows x86-64

ridal-0.4.7-cp313-cp313-manylinux_2_39_x86_64.whl (3.3 MB view details)

Uploaded CPython 3.13manylinux: glibc 2.39+ x86-64

ridal-0.4.7-cp312-cp312-win_amd64.whl (4.5 MB view details)

Uploaded CPython 3.12Windows x86-64

ridal-0.4.7-cp312-cp312-manylinux_2_39_x86_64.whl (3.3 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.39+ x86-64

ridal-0.4.7-cp311-cp311-win_amd64.whl (4.5 MB view details)

Uploaded CPython 3.11Windows x86-64

ridal-0.4.7-cp311-cp311-manylinux_2_39_x86_64.whl (3.3 MB view details)

Uploaded CPython 3.11manylinux: glibc 2.39+ x86-64

ridal-0.4.7-cp310-cp310-win_amd64.whl (4.5 MB view details)

Uploaded CPython 3.10Windows x86-64

ridal-0.4.7-cp310-cp310-manylinux_2_39_x86_64.whl (3.3 MB view details)

Uploaded CPython 3.10manylinux: glibc 2.39+ x86-64

File details

Details for the file ridal-0.4.7.tar.gz.

File metadata

  • Download URL: ridal-0.4.7.tar.gz
  • Upload date:
  • Size: 602.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: maturin/1.12.6

File hashes

Hashes for ridal-0.4.7.tar.gz
Algorithm Hash digest
SHA256 1870fb95a35325e89bf36389cf0b81b09b9f49f6440f44abbd35aa35d9102abc
MD5 2ca738b5d1c7ec2ae2e32c20a148fac9
BLAKE2b-256 e46ae1bb0d15cf7197d98ff5e878804d1e5c68fc9b981a7c72312cd5bf1ebc40

See more details on using hashes here.

File details

Details for the file ridal-0.4.7-cp313-cp313-win_amd64.whl.

File metadata

  • Download URL: ridal-0.4.7-cp313-cp313-win_amd64.whl
  • Upload date:
  • Size: 4.5 MB
  • Tags: CPython 3.13, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: maturin/1.12.6

File hashes

Hashes for ridal-0.4.7-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 abda1344959a118c849feec0a42365d8003ef0653d13d241145f8a7be858bb4b
MD5 7cbd366aaa1f9a73051276574733f4d4
BLAKE2b-256 ac8cdffd7b0dee9c71da013a054c54aca58ce890fdff46e6685d3d8b95dbc80d

See more details on using hashes here.

File details

Details for the file ridal-0.4.7-cp313-cp313-manylinux_2_39_x86_64.whl.

File metadata

File hashes

Hashes for ridal-0.4.7-cp313-cp313-manylinux_2_39_x86_64.whl
Algorithm Hash digest
SHA256 8cfb6d028499e1957e08d7b4490dbeea4171e42c11723c3e34751a6ef6c9790e
MD5 dd10b469f5466e631427b41d6ecb64d3
BLAKE2b-256 5640769193c394a20b7d983d49810f4d9191a3cec6bf24436fef3be96798935c

See more details on using hashes here.

File details

Details for the file ridal-0.4.7-cp312-cp312-win_amd64.whl.

File metadata

  • Download URL: ridal-0.4.7-cp312-cp312-win_amd64.whl
  • Upload date:
  • Size: 4.5 MB
  • Tags: CPython 3.12, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: maturin/1.12.6

File hashes

Hashes for ridal-0.4.7-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 088e340e034173fa07b3840409f1918a03253f2033fdc6a92ecf82f970d13777
MD5 e464290362bc4d9ff7fef578972db223
BLAKE2b-256 11da5f24ddf563d29a683d75556d92cece73e4310dc820b833f9d0c1811e351d

See more details on using hashes here.

File details

Details for the file ridal-0.4.7-cp312-cp312-manylinux_2_39_x86_64.whl.

File metadata

File hashes

Hashes for ridal-0.4.7-cp312-cp312-manylinux_2_39_x86_64.whl
Algorithm Hash digest
SHA256 a4d7319b45e57bd539586b1cca334449770fd147fbeb3bbd308baeec04fbe0d3
MD5 48cf20b8ddfc822060cf79723b6822c8
BLAKE2b-256 1f1e1093e7ab74c7746159d17a2e086bf7ee7f91e3513a1ea991e829c2fb6d7e

See more details on using hashes here.

File details

Details for the file ridal-0.4.7-cp311-cp311-win_amd64.whl.

File metadata

  • Download URL: ridal-0.4.7-cp311-cp311-win_amd64.whl
  • Upload date:
  • Size: 4.5 MB
  • Tags: CPython 3.11, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: maturin/1.12.6

File hashes

Hashes for ridal-0.4.7-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 5bbaa81317d055666ee0decab682daefabfd48ec13ad88bede418603fe70631e
MD5 d86f8715dd55ef1946e9c341a4b9c4c6
BLAKE2b-256 b381072e9ae602597eb5d465433b6019e6ce50087163aee5a74c30f5cc6a64e2

See more details on using hashes here.

File details

Details for the file ridal-0.4.7-cp311-cp311-manylinux_2_39_x86_64.whl.

File metadata

File hashes

Hashes for ridal-0.4.7-cp311-cp311-manylinux_2_39_x86_64.whl
Algorithm Hash digest
SHA256 02cc19f7cc946b07a74dc095970ddc456204cb9914499cd6d741541dcda1b148
MD5 f2b8addc83e9f4be12dbf0777b3771e1
BLAKE2b-256 77173104bf1deff126c940b13c0d3616ef398ec0cd9406ab85672a5f2487ad3f

See more details on using hashes here.

File details

Details for the file ridal-0.4.7-cp310-cp310-win_amd64.whl.

File metadata

  • Download URL: ridal-0.4.7-cp310-cp310-win_amd64.whl
  • Upload date:
  • Size: 4.5 MB
  • Tags: CPython 3.10, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: maturin/1.12.6

File hashes

Hashes for ridal-0.4.7-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 422885dd1b7d0db4628a84280e3c01b8612b9d4e4d36eac68524e0b1b01f689d
MD5 da4b1bf8ef4aa17fe8cb400efe994ce0
BLAKE2b-256 f494b5b37c195aa1ff39f34488a720080bfd69250d78e610837dd7bb23fc27b7

See more details on using hashes here.

File details

Details for the file ridal-0.4.7-cp310-cp310-manylinux_2_39_x86_64.whl.

File metadata

File hashes

Hashes for ridal-0.4.7-cp310-cp310-manylinux_2_39_x86_64.whl
Algorithm Hash digest
SHA256 3f51e14a51e7fe062db6d4cb67866ff5132f20cb0f80981ab60bc6b42c9b0e23
MD5 3bb8175ae230ccb8227233bb1767d26c
BLAKE2b-256 ce9b793f928cbfe9a13f0821d15c419cb6abf38e2a57e871ce019a6bb7c398ff

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page