/reda

Reproducible Electrical Data Analysis

Primary LanguagePythonMIT LicenseMIT

REDA - Reproducible Electrical Data Analysis

License: MIT Join the chat at https://gitter.im/geophysics-ubonn/reda

Latest release: 0.2.0 (29. Apr. 2024)

See releases page for a complete list of releases. Releases are also published to Pypi.

REDA is a scientific Python library for reproducible geoelectrical data analysis. It aims to provide a unified interface for common and advanced data processing steps while bridging the gap between a multitude of geoelectric measurement devices and inversion codes used across the geophysical community. It offers functionality to import, analyze, process, visualize, and export geoelectrical data with particular emphasis on time-lapse functionality and reproducibility. The latter is realized in the form of a logging system, which keeps track of each individual processing step applied to particular data set in a human-readable journal. REDA is platform compatible, tested and open-source under the permissive MIT license. Any contributions from the community are highly welcome.

REDA is a work-in-progress. Please contact us if you wish to use it or miss a specific functionality. Please see the status page for more information.

In which scenarios is reda useful?

Import data from a device-specific file format

Example::

import reda
ert = reda.ERT()
ert.import_syscal_bin('data_from_a_syscal_device.bin')
print(ert.data[['a', 'b', 'm', 'n', 'r']])

See the status page for supported device/software file formats.

Installation

Install latest release from PyPI (https://pypi.org/project/reda/):

pip install reda

Install current development version from git:

pip install git+https://github.com/geophysics-ubonn/reda

For more information, refer to the !installation page of the documentation.

Documentation

An online version of the docs can be found here: https://geophysics-ubonn.github.io/reda

Contributing

We look forward to any type of contributions:

  • code contribution
  • example contributions
  • documentation help
  • issuing bug reports

If in doubt, use the Gitter chat to contact us (click the Gitter badge above to join the chat).