Skip to main content

geoscilabs

Project description

# GeoSci Labs

[![binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/geoscixyz/geosci-labs/master?filepath=notebooks%2Findex.ipynb) [![pypi](https://img.shields.io/pypi/v/geoscilabs.svg)](https://pypi-hypernode.com/pypi/geoscilabs) [![License](https://img.shields.io/github/license/geoscixyz/geosci-labs.svg)](https://github.com/geoscixyz/geosci-labs/blob/master/LICENSE) [![SimPEG](https://img.shields.io/badge/powered%20by-SimPEG-blue.svg)](http://simpeg.xyz)

This is a repository of code used to power the notebooks and interactive examples for https://em.geosci.xyz and https://gpg.geosci.xyz.

The examples are based on code available in [SimPEG](http://simpeg.xyz).

## Why

Interactive visualizations are a powerful way to interrogate mathematical equations. The goal of this repository is to be the home for code that can be plugged into jupyter notebooks so that we can play with the governing equations of geophysical electromagnetics.

## Scope

The repository contains the python code to run the ipython-widget style apps in http://github.com/geoscixyz/geosci-labs. These are mainly plotting code and some simple analytics. More complex numerical simulations depend on [SimPEG](http://simpeg.xyz)

## Usage

The notebooks can be run online through [Binder](#Binder), or [downloaded and run locally](#Locally).

### Binder

[![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/geoscixyz/geosci-labs/master?filepath=notebooks%2Findex.ipyn)

  1. Launch the binder by clicking on the badge above or going to: https://mybinder.org/v2/gh/geoscixyz/geosci-labs/master?filepath=notebooks%2Findex.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](#Running-the-notebooks)

![Binder-steps](https://em.geosci.xyz/_images/binder-steps.png)

### Locally

To run them locally, you will need to have python installed, preferably through [anaconda](https://www.anaconda.com/download/).

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

` git clone https://github.com/geoscixyz/geosci-labs.git `

Then cd into geosci-labs

` cd geosci-labs `

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

` conda env create -f environment.yml conda activate geosci-labs `

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](https://em.geosci.xyz/_images/run_all_cells.png)

For more information on running Jupyter notebooks, see the [Jupyter Documentation](https://jupyter.readthedocs.io/en/latest/)

## Using in a course

## Issues

If you run into problems or bugs, please let us know by [creating an issue](https://github.com/geoscixyz/geosci-labs/issues/new) in this repository.

## For Contributors

We are glad you are interested in contributing! Please check out the [contributing guide](CONTRIBUTING.md) for ideas of how to get involved.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

geoscilabs-0.2.5.tar.gz (180.1 kB view details)

Uploaded Source

Built Distribution

geoscilabs-0.2.5-py3-none-any.whl (238.2 kB view details)

Uploaded Python 3

File details

Details for the file geoscilabs-0.2.5.tar.gz.

File metadata

  • Download URL: geoscilabs-0.2.5.tar.gz
  • Upload date:
  • Size: 180.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.6.0.post20210108 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.5

File hashes

Hashes for geoscilabs-0.2.5.tar.gz
Algorithm Hash digest
SHA256 c3c922097927954f847e19ade8feff39674a4f0501f66d9699d29136363015b7
MD5 6c772c20ad3dd0ab3244d5cdf80cd78b
BLAKE2b-256 133e1b156ab8f7496a1208359da9f524cdc0fffea097a7bbcbe4f86f734a5132

See more details on using hashes here.

File details

Details for the file geoscilabs-0.2.5-py3-none-any.whl.

File metadata

  • Download URL: geoscilabs-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 238.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.6.0.post20210108 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.5

File hashes

Hashes for geoscilabs-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 4817c7fed1c9dba2a355299ed0ac2874247b9029611e0858fc7beab9215de020
MD5 51053aa50a771b08bc80dec1389bb395
BLAKE2b-256 bf7b5a7759f2a2a62e5c87aed15b8e803025c53e0ba2c06df88e9a253eb834fb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page