Interactive applications for electromagnetics in geophysics
Clone or download
Latest commit 6fbed74 Oct 24, 2018

README.md

overview | launching the notebooks | running the notebooks | issues | contributing

em-apps

binder azure travis SimPEG

Overview

This is a repo of notebooks and interactive examples for http://em.geosci.xyz. The examples are based on code available in em_examples. Numerical simulations are based on SimPEG.

The notebooks are available on

Launching the notebooks

The notebooks can be run online through Binder or Azure notebooks, or downloaded and run locally.

Binder

Binder

  1. Launch the binder by clicking on the badge above or going to: https://mybinder.org/v2/gh/geoscixyz/em-apps/master?filepath=index.ipynb. This can sometimes take a couple minutes, so be patient...

  2. Select the notebook of interest from the contents

  3. Run the Jupyter notebook

Binder-steps

Azure

Azure

  1. Navigate to Azure notebooks by clicking on the badge above or going to: https://notebooks.azure.com/import/gh/geoscixyz/em-apps, and select Import to import the library

  2. Sign in to your microsoft account (or Create One if you do not already have an account)

  3. Create the new library: Select Import

  4. Select index.ipynb to view the notebook contents

  5. Select the notebook of interest from the contents

  6. Run the Jupyter notebook

Azure-steps

Locally

To run them locally, you will need to have python installed, preferably through anaconda.

You can then clone this reposiroty. From a command line, run

git clone https://github.com/geoscixyz/em-apps.git

Then cd into em-apps

cd em-apps

To setup your software environment, we recommend you use the provided conda environment

conda env create -f environment.yml
source activate em-apps-environment

alternatively, you can install dependencies through pypi

pip install -r requirements.txt

You can then launch Jupyter

jupyter notebook

Jupyter will then launch in your web-browser.

Running the notebooks

Each cell of code can be run with shift + enter or you can run the entire notebook by selecting cell, Run All in the toolbar.

cell-run-all

For more information on running Jupyter notebooks, see the Jupyter Documentation

Issues

If you run into problems or bugs, please let us know by creating an issue in this repository.

For Contributors

Notebook Structure

Each notebook has the following structure

  • Purpose : Motivation and key concepts addressed by the notebook
  • Setup : Overview of the relevant parameters in the problem
  • Questions : Guiding questions related to the purpose
  • App : interactive visualizations
  • Explore : further questions that can be explored with the app

Conventions

For colormaps (http://matplotlib.org/examples/color/colormaps_reference.html)

  • fields are plotted with the viridis
  • potentials are plotted with viridis
  • sensitivities are plotted with viridis
  • physical properties are plotted with jet
  • charges are plotted with RdBu

Order of widgets:

  • geometry of survey
  • geomerty target
  • physical properties of target
  • view options

Setting up your environment