Skip to content

Commit 141b4de

Browse files
authored
Add Binder link and point to nbviewer
Include Binder instructions and a link to the nbviewer rendered version of this repository since the GitHub rendering of notebooks is bad and you can't copy/paste.
1 parent 206f70e commit 141b4de

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,30 @@
1-
# Fatiando a Terra Tutorials
1+
# Fatiando a Terra tutorials
22

33
Jupyter notebooks with tutorials for using Fatiando a Terra software to solve
44
data problems in geoscience.
55

6+
## Run the tutorials online
7+
8+
The easiest way to run the code in our tutorials is through the
9+
excellent [Binder](https://mybinder.org/) service.
10+
Click on the badge below and Binder will open up a JupyterLab instance on their
11+
servers with the tutorial code.
12+
Easy as that!
13+
14+
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/fatiando/tutorials/HEAD)
15+
16+
> **WARNING:** Binder will not save any changes you make and may shutdown your
17+
> JupyterLab without warning. This is a good way to explore but if you intend
18+
> on editing the notebook then we recommend running things on your machine.
19+
20+
## View the notebooks
21+
22+
You can also browse the code and text in the notebooks online (but won't be
23+
able to run the code).
24+
To do so, click on any of the `.ipynb` files in this GitHub repository.
25+
Alternatively, the [nbviewer](https://nbviewer.org/github/fatiando/tutorials/tree/main/)
26+
version can be better and more reliable.
27+
628
## License
729

830
All Python source code is made available under the BSD 3-clause license. You

0 commit comments

Comments
 (0)