search

NSGeophysics / GPRPy

Ground Penetrating Radar processing and visualization software for python
MIT License
193 stars 89 forks source link

readme

GPRPy

Open-source Ground Penetrating Radar processing and visualization software. Supported by the National Science Foundation under grants EAR-1550732 and EAR-2022671

Please cite https://library.seg.org/doi/10.1190/tle39050332.1

Profile GUI

CMP/WARR GUI

Simplemost installation

In the following instructions, if you use Windows, use the comands python and pip. If you use Mac or Linux, use the commands python3 and pip3 instead.

1) Download the GPRPy software from https://github.com/NSGeophysics/GPRPy/archive/master.zip.
Save the file somewhere on your computer and extract the zip folder.
As an alternative, you can install git from https://git-scm.com/, then run in a command prompt:
git clone https://github.com/NSGeophysics/GPRPy.git
The advantage of the latter is that you can easily update your software by running from the GPRPy folder in a command prompt:
git pull origin master

2) Install Python 3.7 or higher. You can obtain it for example from https://conda.io/miniconda.html

3) Once the installation finished, open a command prompt that can run Python
On Windows: click on Start, then enter "Anaconda Prompt", without the quotation marks into the "Search programs and files" field. On Mac or Linux, open the regular terminal.

4) In the command prompt, change to the directory where you downloaded the GPRPy files. This is usually through a command like for example
cd Desktop\GPRPy
if you downloaded GPRPy directly onto your desktop. Then type the following and press enter afterward:
python installMigration.py
Then type the following and press enter afterward:
pip install .
don't forget the period "." at the end of the pip install command

Running the software

After installation, you can run the script from the Anaconda Prompt (or your Python-enabled prompt) by running either
gprpy
or
python -m gprpy

The first time you run GPRPy it could take a while to initialize. GPRPy will ask you if you want to run the profile [p] or WARR / CMP [c] user interface. Type
p
and then enter for profile, or
c
and then enter for CMP / WARR.

You can also directly select one by running either
gprpy p
or
gprpy c
or
python -m gprpy p
or
python -m gprpy c

Running automatically generated scripts

To run automatically generated scripts, open the command prompt that can run python (for example Anaconda Prompt), switch to the folder with the automatically generated script and run
python myscriptname.py
where myscriptname.py is the name of your automatically generated script.

In case of trouble

If you have several versions of python installed, for example on a Mac or Linux system, replace, in the commands shown earlier, python with python3
and
pip with pip3

If you have any troubles getting the software running, please send me an email or open an issue on GitHub and I will help you getting it running.

Uninstalling GPRPy

To uninstall GPRPy, simply run, in the (Anaconda) command prompt
pip uninstall gprpy

News

Follow @GPRPySoftware on twitter to hear about news and updates. Recent tweets: