Welcome to resistics¶
Resistics is an open-source, native Python 3 package for the processing of magnetotelluric (MT) data. It incorporates standard robust regression methods and adopts a modular approach to processing which allows for customisation and future improvements to be quickly adopted.
Magnetotellurics in the rain¶
Latest news¶
2020-03-15: Resistics 0.0.6 has been released to the python package repository. No new features were added between 0.0.6rc1 and 0.0.6. There were no major changes apart from those to fix bugs and issues. Additionally, an initial set of unit tests has been added and more will be added in the future.
Warning
Version 0.0.6 of resistics is no longer backwards compatible with scripts written for resistics versions prior to 0.0.6.dev3. Scripts written using older versions of the package will fail due to broken imports. All documentation has been re-written to match the new structure.
The latest version of resistics can be downloaded using pip in the normal way.
python -m pip install --upgrade resistics
For more information on what has changed, please view the changelog.
About¶
Resistics began as a set of Python classes to help analyse noisy MT timeseries data acquired in northern Switzerland through increased use of statistics and time window based features. Since then, it has grown into a MT data processing package. The name is an amalgamation of resistivty and statistics…resistics!
Whilst other codes exist, resistics was written for the following purpose:
Freely accessible (MIT licence), open-source and cross platform
Compatible with several time data formats and corresponding calibration data
Dataset investigation, tools for dealing with noisy MT data
Well documented with clear explanation of methods, tutorials, advanced examples and a cookbook for showcasing lower level API usage.
Audience¶
Resistics is intended for people who use magnetotelluric methods to estimate the subsurface resistivity. This may be for the purposes of furthering geological understanding, for geothermal prospecting or for other purposes.
Getting started¶
Installation instructions are provided here. The quickest way to get started with resistics is to install it from pip, the python package repository, and continue through to the tutorial.
python -m pip install --user resistics
Resistics uses a number of conventions which are described here. Find out about the useful features of resistics in the features section. Information about supported data and calibration formats is provided in the formats section.
The tutorial section covers the resistics project environment and basic processing of magnetotelluric data. More advanced processing, including pre-processing of timeseries data, remote reference processing and remote reference statistics are detailed in the advanced section. Specialised functionality or examples of using lower level APIs will be added in the cookbook as and when it is developed. The case studies will cover the use of resistics to process complete field surveys. A complete API reference can be found here.
A changelog and backlog for future resistics development can be accessed here. Useful magnetotelluric references are provided in the Bibliography.
For those interested in seeing who is contributing to the project and how resistics can be cited see the Credits. Anyone who wants to donate can do so here.
Open-source¶
Resistics is available for free under the MIT licence. The resistics source code can be found in the GitHub repository. Contributors are welcome.