Skip to content

Commit 8cf45e7

Browse files
committed
Merge branch 'release' into barnhark/rockblock
2 parents 9f072c1 + 1e1bea7 commit 8cf45e7

4 files changed

Lines changed: 809 additions & 109 deletions

File tree

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,12 @@ conventions that we would like you to follow.
9696
be rendered.
9797
* Your tutorial must be able to run without error for the **most
9898
recent landlab release**.
99+
* If your tutorial runs with the most recent **release** of landlab,
100+
a pull request should be sent to the *release* branch.
101+
* If you tutorial does not work with the most recent release but does
102+
work with a development version of landlab that's yet to be release,
103+
submit a pull request to the *next* branch.
104+
99105

100106
Thanks! :heart: :heart: :heart:
101107

README.md

Lines changed: 30 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,33 @@ Status](https://travis-ci.org/landlab/tutorials.svg?branch=master)](https://trav
33

44
[![Landlab header](./landlab_header.png)](http://landlab.github.io)
55

6-
Most of these Landlab tutorials can either be read as text files or run as interactive IPython notebooks (recommended!).
7-
8-
To run the IPython notebook tutorials locally, you can copy this [landlab/tutorials](https://github.com/landlab/tutorials) repo to your local working environment (use the ``download ZIP`` button or fork/clone, whichever is most familiar to you).
9-
10-
Alternatively, you can also access each notebook online from [https://nbviewer.jupyter.org/github/landlab/tutorials](https://nbviewer.jupyter.org/github/landlab/tutorials) and download an individual notebook (navigate to the specific IPython notebook you want, open it, and click the download button that appears in the upper right).
11-
12-
After downloading/cloning, navigate into your new directory (or to the directory containing your new download) from the command line in your terminal.
13-
14-
Use the command ``$ jupyter notebook`` to launch Jupyter, the IPython notebook viewer (it will open locally in your browser). Then navigate to the ``.ipynb`` tutorial you want to run and click to open it.
15-
16-
To run the code in the notebook, place your cursor in a code cell, hold down ``shift``, and press ``enter``. The order in which you run the cells matters. You can even experiment with typing your own code into the cell and running that.
17-
18-
Here is a short IPython notebook tutorial along with a screencast (the tutorial uses an example with statistics, but you can substitute Landlab!): http://www.randalolson.com/2012/05/12/a-short-demo-on-how-to-use-ipython-notebook-as-a-research-notebook/
6+
Most of these Landlab tutorials can either be read as text files or run
7+
as interactive IPython notebooks (recommended!).
8+
9+
To run the IPython notebook tutorials locally, you can copy this
10+
[landlab/tutorials](https://github.com/landlab/tutorials) repo to your
11+
local working environment (use the ``download ZIP`` button or fork/clone,
12+
whichever is most familiar to you).
13+
14+
Alternatively, you can also access each notebook online from
15+
[https://nbviewer.jupyter.org/github/landlab/tutorials](https://nbviewer.jupyter.org/github/landlab/tutorials)
16+
and download an individual notebook (navigate to the specific IPython
17+
notebook you want, open it, and click the download button that appears
18+
in the upper right).
19+
20+
After downloading/cloning, navigate into your new directory (or to
21+
the directory containing your new download) from the command line
22+
in your terminal.
23+
24+
Use the command ``$ jupyter notebook`` to launch Jupyter, the IPython
25+
notebook viewer (it will open locally in your browser). Then navigate
26+
to the ``.ipynb`` tutorial you want to run and click to open it.
27+
28+
To run the code in the notebook, place your cursor in a code cell,
29+
hold down ``shift``, and press ``enter``. The order in which you
30+
run the cells matters. You can even experiment with typing your own code
31+
into the cell and running that.
32+
33+
Here is a short IPython notebook tutorial along with a screencast
34+
(the tutorial uses an example with statistics, but you can
35+
substitute Landlab!): http://www.randalolson.com/2012/05/12/a-short-demo-on-how-to-use-ipython-notebook-as-a-research-notebook/

0 commit comments

Comments
 (0)