Skip to content

Commit b983497

Browse files
authored
Update README.md
1 parent 4056f77 commit b983497

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
1-
# loopstructural_paper_examples
2-
Notebooks and examples for the LoopStructural paper
1+
# LoopStructural 1.0: Time aware geological modelling
2+
https://doi.org/10.5194/gmd-2020-336
33

4-
It is best to run this notebook using docker.
4+
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).
55

6-
docker pull loop3d/loop
7-
docker run -it -p 8888:8888 -v thisgitrepo:/home/jovyan/notebooks
6+
**WARNING: Some of the notebooks may be too heavy to run on cloud services**
7+
8+
## Running using docker
9+
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.
10+
11+
## Installing locally
12+
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 commit comments

Comments
 (0)