MGomezN/agrogeo24

Teaching resources for the SimPEG workshop at Agrogeo24 in Zurich, SW

SimPEG tutorial for Agrogeo24

Instructors: Devin C. Cowan¹ and Santiago Soler¹

¹ Geophysical Inversion Facility. Earth Ocean and Atmospheric Sciences. University of British Columbia.

Information
Where	ETH Zürich, Switzerland
When	Feb 1 and Feb 2, 2024
Organizer	Agrogeophysics Organizing Committee
Website of the event	agrogeophy.github.io/agrogeo24

About

We were invited by Agrogeo24 to give a workshop about SimPEG, to show the agrogeophysical community how we can use SimPEG to run forward simulations of DC resistivity data (ERT), and how we can invert that type of data.

Come and discover the powerful open-source SimPEG framework whose development is led by UBC. You will learn how to set-up an inversion in SimPEG using an example from ERT, then you will get the chance to set up an inversion scheme yourselves and finally get some information on how to proceed for your own data set.

During this workshop we'll go through two Jupyter notebooks that showcase examples on how we can run forward and inverse problems for ERT data:

• 01-forward-dc-resisitivity-2d.ipynb
• 02-inversion-dc-resistivity-2d.ipynb

Setup

During this workshop we'll use Juptyer notebooks to run the forward and inverse modelling of DC resistivity data.

To be able to follow the workshop and run these notebooks, you'll need to have access to a Python environment. This could be done through online services like Google Colab, or through a local Python installation like Anaconda or Miniforge.

By default we'll use Google Colab. But we'll consider installing Python locally in case something goes wrong with the former.

Here will provide instructions to:

• Configure Google Colab
• or Install Python locally

Configure Google Colab

To be able to run the Jupyter notebooks for this tutorial in Google Colab, we'll need to follow these steps:

1. Login to our Google Colab account.
2. Create a new notebook.
3. Install some Python libraries that we'll need to use, such as SimPEG.

Step 1: Login to our Google Colab account

If you don't have a Google account, create one and log in. If you do, you just need to log in.

Step 2: Create a new notebook

1. Access to Google Colab by going to: https://colab.research.google.com
2. Find the top menu and choose File > New notebook. A new tab should open with a blank notebook in it.

Step 3: Install some Python libraries

To be able to follow this workshop we need to install some Python libraries that aren't preinstalled in the default Google Colab environment.

1. Click on the first cell of the notebook (if it's not empty, then create a new Code cell and move it to the first position with the arrows icons that appear on its top-right).
2. Type the following line in the selected cell:

   !pip install simpeg==0.20.0 discretize==0.10.0 pymatsolver==0.2.0
   

   Note the ! sign at the beginning of the line, don't remove it.
3. Run that cell by clicking the Play button on its left or by pressing Shift+Enter in your keyboard. pip should install all the packaged listed in that line. If installation goes smoothly, you should see a line that reads Successfully installed ... and lists all the new packages that had been installed.

Important

Every time you open a notebook in Colab or create a new one, you'll have to reinstall these packages (Google Colab don't save installed states across notebooks).

If it's a new notebook, just follow the previous instructions from the top.

If it's an existing notebook, make sure that it has the !pip install ... line at the top (add it otherwise), and run it.

Install Python locally

To be able to run the Jupyter notebooks for this tutorial in our own machines, we'll have to follow these steps:

1. Install a Python distribution (like Anaconda or miniforge).
2. Create a conda environment with all the Python packages needed (for example, SimPEG).
3. Activate this conda environment and run JupyterLab to start coding.

Step 1: Install a Python distribution

We recommend installing a Python distribution like miniforge or Anaconda.

Both of them will install Python and a package manager that allows us to install new Python libraries (like SimPEG for example), and also create environments.

Anaconda uses the conda package manager, while Miniconda uses the new mamba, which works faster than conda.

If you have either of both installed, you can skip this step. Otherwise, please follow their installation instructions:

• Install miniforge: https://github.com/conda-forge/miniforge#install
• Install Anaconda: https://docs.anaconda.com/anaconda/install

Step 2: Create the simpeg-agrogeo24 conda environment

Important

In the following steps we'll make use of the mamba package manager. In case you installed Anaconda, use conda instead. You can simply replace mamba for conda on every command we ask to use it and it'll work fine.

1. Download the environment.yml file from (right-click and select "Save page as" or similar).
2. Make sure that the file is called environment.yml. Windows sometimes adds a .txt to the end, which you should remove.
3. Open a terminal (Anaconda Prompt or Miniforge Prompt if you are running Windows). The following steps should be done in the terminal.
4. Navigate to the folder that has the downloaded environment file (if you don't know how to do this, take a moment to read the Software Carpentry lesson on the Unix shell).
5. Create the conda environment by running mamba env create --file environment.yml (this will download and install all of the packages used in the tutorial). If you installed Anaconda, then replace mamba for conda in the previous line.

Step 3: Activate the simpeg-agrogeo24 environment and start JupyterLab

Tip

You'll need a browser that is able to run JupyterLab (basically anyone except Internet Explorer or Edge). If you are in Windows, make sure you change your default browser to a different one.

Now we can activate the newly created simpeg-agrogeo24 environment.

1. Open a terminal (Anaconda Prompt or Miniforge Prompt if you are running Windows).
2. Activate the simpeg-agrogeo24 environment by running mamba activate simpeg-agrogeo24. If you installed Anaconda, then replace mamba for conda in the previous line.
3. With the simpeg-agrogeo24 environment activated, we can start JupyterLab by running jupyterlab in the terminal. A new tab in our web browser should open showing JupyterLab's interface.

License

This work is licensed under a Creative Commons Attribution 4.0 International License.