💻 Google Summer of Code 2023:

• Project Name: Create a gprMax Custom Kernel for Jupyter Notebook

• Mentors:

  • Rania Patsia
  • John Hartley

✍🏼 PROJECT DESCRIPTION:

We create a custom gprMax kernel in the Jupyter Notebook which contains all the necessary modules and files from the gprMax installation that can be used within the Jupyter Notebook.

📂 FILES:

• install_notebook_dependencies.py - Used for installing the gprMax-devel kernel on Jupyter Notebook.

• visualization_toolbox - Contains a custom 3D visualization function using the PyVista python library to show the geometry output of the model.

• Modified gprMax files - Adjusted relative imports in these files from the gprMax-devel branch to resolve errors.

• example_notebooks - Folders, each containing a test notebook and related input and output files showcasing gprMax usage in notebooks.

  • cylinder_Ascan_2D
  • cylinder_Bscan_2D
  • GSSI_1500_antenna_dipole_model
  • hertzian_dipole_hs
  • magnetic_dipole_fs

• colab_notebook.ipynb - This file contains instructions of how to install gprMax on a Google Colab notebook, run the model and also visualize the .vti 3D output. An example is also given within it with the cylinder_Ascan_2D file.

Each folder has its own README which gives a short description of its contents.

🚀 INSTALLATION INSTRUCTIONS:

1. Install the gprMax-devel as you would for a normal installation, ensuring that Miniconda and GCC (for Linux/Mac) or Microsoft Build Tools for Visual Studio 2022 (for Windows) are installed.

$ conda update conda
$ conda install git
$ git clone --branch devel https://github.com/gprMax/gprMax.git
$ cd gprMax
$ conda env create -f conda_env.yml
$ conda activate gprMax-devel
$ cd ..
$ pip install -e gprMax

2. We run the install_notebook_dependencies.py file from the terminal which installs the gprMax-devel kernel in the Jupyter Notebook

$ python install_notebook_dependencies.py

📔 NOTEBOOK ENVIRONMENT:

After completing the installation, you can launch your Jupyter Notebook and create a new notebook. From the kernel options, select the gprMax-devel custom kernel that you've installed. This will allow you to use the gprMax functionality seamlessly within your Jupyter Notebook environment.

📄 UPDATED gprMax FILES:

During the installation of gprMax on a system running Fedora 38, the evtk imports were producing errors. So I edited a few lines of the code that handles the import inheritance of the evtk module.

🔗 ISSUED PULL REQUEST:

A pull request has been issued to add my work done of some changes and updates and new feature to the original gprMax repo. The pull request can be found below:

PULL REQUEST

🎉 FINAL NOTE:

Feel free to explore and experiment with the gprMax custom kernel in your Jupyter Notebook environment. If you encounter any issues or have questions, don't hesitate to reach out for assistance.

Happy coding!

---

I also made a very concise Notion page where I wrote little parts of what I did, just like that. It's not at all comprehensive, it's just for fun.

Notion Page