API for resistivity and IP inversion/modelling around R* codes
pip install resipy==3.5.4
(Note that ResIPy was called pyR2 before 2019-04-16)
ResIPy is a Python wrapper around the R2 family of codes (for 2D/3D DC/IP inversion). ResIPy provides a standalone graphical user interface (GUI) along with a Python API (Application Programming Interface) for use in Jupyter notebook. Have a look at the documentation and the examples to know more.
ResIPy aims to be
Note for Windows users:
Notes for Mac and Linux users:
sudo chmod 775 ResIPy
General overlook of the project structure with the three main parts.
Don't hesitate to consult the CONTRIBUTING.md for more informations.
The full description of the API can be found in the documentation.
After downloading or cloning (git clone https://gitlab.com/hkex/pyr2
) the repository,
you can run the GUI using:
cd pyr2/src
python ui.py
You can also try out the API on or using:
cd pyr2/jupyter-notebook
python -m notebook # or just 'jupyter notebook'
ResIPy contains executables that are built only for windows. To run them you will need to install wine.
sudo apt-get install wine-stable # if using debian/ubuntu based distribution
sudo pacman -S install wine # if using arch based distribution
IMPORTANT NOTE: wine is partially supported on macOS Catalina! Please try installing wine v5.x with below instructions first.
ResIPy cannot be run from within the dmg. You must drag it to a folder on your filesystem (e.g., Applications, Desktop).
You first need to install wine
through homebrew
to be able to run .exe
files on you Mac OS X.
Open "terminal" and install homebrew
with:
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
Follow the instructions. (You may need to install Command Line Tools)
Once the homebrew
installation is successfully done, install xquartz
by below command in terminal:
brew cask install xquartz
Then install wine
:
brew install wine
If all is done with no errors, you are ready to run the GUI by:
cd pyr2/src
python ui.py
You also can run any .exe
files by this command:
wine /your example.exe file directory/example.exe
**NOTE: the first time you're running wine
it will need to be updated and that will take some time.
If wine does not run properly on your Catalina machine, try these instructions instead.
If there is a feature you would like to see in the API or the GUI or if there is a bug you want to report, please raise an issue on Gitlab describing it. We need to be able to reproduce the issue in order to fix it, so please provide example files and error log, related to your issue.
If you wish to contribute to the code, please familiarize yourself with the .
If you use ResIPy for you work, please cite this paper as:
Blanchy G., Saneiyan S., Boyd J., McLachlan P. and Binley A. 2020.
“ResIPy, an Intuitive Open Source Software for Complex Geoelectrical Inversion/Modeling.”
Computers & Geosciences, February, 104423. https://doi.org/10.1016/j.cageo.2020.104423.
BibTex code:
@article{blanchy_resipy_2020,
title = {{ResIPy}, an intuitive open source software for complex geoelectrical inversion/modeling},
issn = {0098-3004},
url = {http://www.sciencedirect.com/science/article/pii/S0098300419308192},
doi = {10.1016/j.cageo.2020.104423},
pages = {104423},
journaltitle = {Computers \& Geosciences},
author = {Blanchy, Guillaume and Saneiyan, Sina and Boyd, James and {McLachlan}, Paul and Binley, Andrew},
urldate = {2020-02-07},
date = {2020-02-04},
langid = {english}
}
Before v2.0.0 (included), the Windows version of ResIPy had a bug that causes the temporary folder where ResIPy runs to not
be deleted when the program closed. This has been corrected in v2.0.1. When running multiple times this can
take up space. Navigate to C:\Users\<username>\AppData\Local\Temp
if you want to manually delete them. Those files can
be automatically deleted by Windows or third party apps (such as CC cleaner) when there is low disk-space.
Below are the links to current and previous releases of ResIPy/pyR2. Note that previous releases may contain bugs/issues and it is recommended to always use the latest release available.
Current stable release:
Past releases: