Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lachlangrose committed Apr 9, 2021
1 parent 4056f77 commit b983497
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
@@ -1,7 +1,12 @@
# loopstructural_paper_examples
Notebooks and examples for the LoopStructural paper
# LoopStructural 1.0: Time aware geological modelling
https://doi.org/10.5194/gmd-2020-336

It is best to run this notebook using docker.
This repository contains the jupyter notebooks used to create the case studies in the paper. To run the notebooks either import them directly into google colab or use [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/lachlangrose/loopstructural_paper_examples/HEAD).

docker pull loop3d/loop
docker run -it -p 8888:8888 -v thisgitrepo:/home/jovyan/notebooks
**WARNING: Some of the notebooks may be too heavy to run on cloud services**

## Running using docker
The notebooks can be run using a docker container. On a unix system simply run docker-compose up -d in this repository directory and a jupyter notebook server will be started with the examples. You wil be able to access the notebook server by visitng localhost:8899.

## Installing locally
Alternatively, the notebooks can be run locally by installing the required dependencies. For LoopStructural `pip install LoopStructural` will install the most recent version of LoopStructural.

0 comments on commit b983497

Please sign in to comment.