Merge branch 'mcflugen/test-notebooks' of github.com:landlab/tutorials into mcflugen/test-notebooks

Author: mcflugen

.travis.yml

@@ -35,6 +35,6 @@ install:
 - conda install landlab jupyter -c landlab
 - conda info -a && conda list
 script:
-- ./run_notebook.py **/*.ipynb --skip='*_unexpanded*' --skip='*intro*' --skip='flow*' --skip='fields*'
+- ./run_notebook.py **/*.ipynb --skip='*_unexpanded*' --skip='*intro*' --skip='flow*'
 virtualenv:
   system_site_packages: false

CONTRIBUTING.md

@@ -0,0 +1,102 @@
+# Contributing to landlab tutorials
+
+Thank you for contributing to the landlab tutorials! We appreciate
+your help as this is largely as volunteer effort! :heart: :heart: :heart:
+
+# How to contribute
+
+## Reporting Bugs
+
+Before creating a bug report, please do at least a cursory check that the
+bug has not already been reported. If it has, add a comment to the existing
+issue instead of opening a new one.
+
+### Submitting a Bug Report
+
+Bugs are tracked as
+[GitHub issues](https://guides.github.com/features/issues/). After you've
+determined you've found a new bug, please open a
+[new issue](https://github.com/landlab/tutorials/issues).
+
+Explain the problem and include additional details to help maintainers
+reproduce the problem. Here are some items that will make it easier
+to track down the source of the problem.
+
+*  **Use a clear and descriptive title** for the issue that identifies the
+   problem.
+*  **Describe the exact steps that reproduce the problem**.
+*  **If possible, provide an example that demonstrates the step** as,
+   for example, a bash script along with input files.
+*  **Describe the behavior you are seeing after these steps**.
+*  **Describe the behavior you expect to see after these steps**.
+
+Additionally, the answers to the following questions about your run
+environment will be helpful.
+
+*  **Which version of landlab are you using?** This could be a specific
+   git sha or a release number.
+*  **What is he name and version of you OS?**
+*  **What compiler are you using?**
+*  **How did you build landlab (if using the development version)?**
+
+
+## Submitting Changes
+
+:tada: Whoa! This is great! We love it when folks contibute code! :tada:
+
+Changes to landlab tutorials should be submitted as 
+[pull requests](http://help.github.com/pull-requests/)).
+
+*  Create a GitHub issue that describes what you propose to do.
+*  Create a topic branch that contains your changes.
+*  Open a new [GitHub pull request](https://github.com/landlab/tutorials/pull/new/master).
+*  Ensure the PR description clearly describes the problem and solution.
+   Include the relevant issue number.
+
+## Styleguides
+
+Use the [PEP8 style guide](https://www.python.org/dev/peps/pep-0008/).
+You may want to use tools like
+[Prospector](http://prospector.landscape.io/en/master/) to help out
+with this.
+
+### Git Commit Messages
+
+* Use the present tense ("Add feature" not "Added feature")
+* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+* Limit the first line to 72 characters or less
+* Reference issues and pull requests liberally
+* Consider starting the commit message with an applicable emoji:
+    * :art: `:art:` when improving the format/structure of the code
+    * :racehorse: `:racehorse:` when improving performance
+    * :non-potable_water: `:non-potable_water:` when plugging memory leaks
+    * :memo: `:memo:` when writing docs
+    * :penguin: `:penguin:` when fixing something on Linux
+    * :apple: `:apple:` when fixing something on macOS
+    * :checkered_flag: `:checkered_flag:` when fixing something on Windows
+    * :bug: `:bug:` when fixing a bug
+    * :fire: `:fire:` when removing code or files
+    * :green_heart: `:green_heart:` when fixing the CI build
+    * :white_check_mark: `:white_check_mark:` when adding tests
+    * :shirt: `:shirt:` when removing linter warnings
+
+## Adding new tutorials
+
+If you would like to create a new tutorial that we have just a few
+conventions that we would like you to follow.
+
+* Create a new folder that will hold your tutorial notebook
+  and data used by your tutorial.
+* Start with the blank tutorial template provided in this repository.
+* Notice that your first cell of code should import `print_function`
+  from `__future__`.  Your tutorial will need to be compatible with
+  both Python 2.7 and 3.4+.
+* If you will be plotting anything, be sure to use include ipython
+  magic command in the first cell to indicate how plots should
+  be rendered.
+* Your tutorial must be able to run without error for the **most
+  recent landlab release**.
+
+Thanks! :heart: :heart: :heart:
+
+The landlab team

fields/working_with_fields.ipynb

@@ -171,15 +171,15 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "ERROR: The field already exists.\n"
+      "ERROR: This field name already exists!\n"
      ]
     }
    ],
    "source": [
     "try:\n",
     "    no_1c = mg.add_field('node', 'field__number_one', input_array, copy=False, units='m')\n",
     "except FieldError:\n",
-    "    print('ERROR: The field already exists.')"
+    "    print('ERROR: This field name already exists!')"
    ]
   },
   {

run_notebook.py

@@ -44,12 +44,45 @@ def run_notebook(notebook):
             os.remove(script_file)
 
 
+def print_summary(summary):
+    print('-' * 70)
+    for notebook, result in summary:
+        if result is None:
+            status('SKIP: ' + notebook)
+        elif result:
+            success(notebook)
+        else:
+            error(notebook)
+    print('-' * 70)
+
+
+def print_success_or_failure(summary):
+    failures = [name for name, result in summary if result is False]
+    passes = [name for name, result in summary if result is True]
+
+    if failures:
+        print('FAILED (failures={nfails})'.format(nfails=len(failures)))
+    else:
+        print('OK Ran {ntests} tests'.format(ntests=len(passes)))
+
+    return len(failures)
+
+
+def check_notebook(notebook):
+    try:
+        run_notebook(notebook)
+    except subprocess.CalledProcessError:
+        return False
+    else:
+        return True
+
+
 def main():
     import argparse
     parser = argparse.ArgumentParser()
     parser.add_argument('notebook', type=str, nargs='+',
                         help='Notebook to test.')
-    parser.add_argument('--skip', type=str, action='append',
+    parser.add_argument('--skip', type=str, action='append', default=[],
                         help='Notebooks to skip.')
 
     args = parser.parse_args()
@@ -61,38 +94,14 @@ def main():
     summary = []
     for notebook in args.notebook:
         if notebook in skip:
-            summary.append((notebook, 'SKIP'))
-            status('SKIP: ' + notebook)
+            result = notebook, None
         else:
-            try:
-                run_notebook(notebook)
-            except subprocess.CalledProcessError:
-                summary.append((notebook, 'FAIL'))
-                error(notebook)
-            else:
-                summary.append((notebook, 'PASS'))
-                success(notebook)
-
-    print('-' * 70)
-    print('Summary:')
-    for notebook, result in summary:
-        if result == 'FAIL':
-            error(notebook)
-        elif result == 'PASS':
-            success(notebook)
-        elif result == 'SKIP':
-            status('SKIP: ' + notebook)
-    print('-' * 70)
-
-    failures = [name for name, result in summary if result == 'FAIL']
-    passes = [name for name, result in summary if result == 'PASS']
+            result = notebook, check_notebook(notebook)
+        print_summary([result])
+        summary.append(result)
 
-    if failures:
-        print('FAILED (failures={nfails})'.format(nfails=len(failures)))
-    else:
-        print('OK Ran {ntests} tests'.format(ntests=len(passes)))
-
-    return len(failures)
+    print_summary(summary)
+    return print_success_or_failure(summary)
 
 
 if __name__ == '__main__':

tutorial_template.ipynb

@@ -2,20 +2,14 @@
  "cells": [
   {
    "cell_type": "markdown",
-   "metadata": {
-    "deletable": true,
-    "editable": true
-   },
+   "metadata": {},
    "source": [
     "<a href=\"http://landlab.github.io\"><img style=\"float: left\" src=\"https://raw.githubusercontent.com/landlab/tutorials/master/landlab_header.png\"></a>\n"
    ]
   },
   {
    "cell_type": "markdown",
-   "metadata": {
-    "deletable": true,
-    "editable": true
-   },
+   "metadata": {},
    "source": [
     "# Using the Landlab flexure component\n",
     "\n",
@@ -32,10 +26,7 @@
   },
   {
    "cell_type": "markdown",
-   "metadata": {
-    "deletable": true,
-    "editable": true
-   },
+   "metadata": {},
    "source": [
     "A bit of magic so that we can plot within this notebook."
    ]
@@ -44,22 +35,17 @@
    "cell_type": "code",
    "execution_count": null,
    "metadata": {
-    "collapsed": true,
-    "deletable": true,
-    "editable": true
+    "collapsed": true
    },
    "outputs": [],
    "source": [
-    "%matplotlib auto\n",
-    "import numpy as np"
+    "from __future__ import print_function\n",
+    "%matplotlib inline"
    ]
   },
   {
    "cell_type": "markdown",
-   "metadata": {
-    "deletable": true,
-    "editable": true
-   },
+   "metadata": {},
    "source": [
     "## This\n",
     "\n",
@@ -68,10 +54,7 @@
   },
   {
    "cell_type": "markdown",
-   "metadata": {
-    "deletable": true,
-    "editable": true
-   },
+   "metadata": {},
    "source": [
     "## That\n",
     "\n",
@@ -80,10 +63,7 @@
   },
   {
    "cell_type": "markdown",
-   "metadata": {
-    "deletable": true,
-    "editable": true
-   },
+   "metadata": {},
    "source": [
     "## The other thing\n",
     "\n",
@@ -92,10 +72,7 @@
   },
   {
    "cell_type": "markdown",
-   "metadata": {
-    "deletable": true,
-    "editable": true
-   },
+   "metadata": {},
    "source": [
     "### Click here for more <a href=\"https://github.com/landlab/landlab/wiki/Tutorials\">Landlab tutorials</a>"
    ]
@@ -121,5 +98,5 @@
   }
  },
  "nbformat": 4,
- "nbformat_minor": 0
+ "nbformat_minor": 1
 }