Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
53 commits
Select commit Hold shift + click to select a range
fac90fe
Add script that will run a notebook(s).
mcflugen Apr 5, 2017
2da4022
Add a template notebook for landlab tutorials.
mcflugen Apr 5, 2017
26f5992
Use new script to run all notebooks.
mcflugen Apr 5, 2017
75427b5
Clean up Travis CI config file.
mcflugen Apr 5, 2017
8c9b054
Change matplotlib inline magic to auto.
mcflugen Apr 5, 2017
1b64641
Remove ipython magic pinfo commands from script.
mcflugen Apr 5, 2017
1455064
Add matplotlib magic.
mcflugen Apr 5, 2017
0b967d1
Remove from __future__ imports.
mcflugen Apr 5, 2017
6884c21
Fix name of scripting package.
mcflugen Apr 5, 2017
1c49e69
Remove use of help function, use ? instead.
mcflugen Apr 5, 2017
bda1a77
Make re pattern string bytes objects.
mcflugen Apr 6, 2017
29042de
Fix finding inline magic in Python 3.
mcflugen Apr 6, 2017
0070232
Fix print statement.
mcflugen Apr 6, 2017
9b7165f
Use byte strings for search and replace.
mcflugen Apr 6, 2017
7099c3d
Add print_function import.
mcflugen Apr 6, 2017
7b782c5
Add skip argument.
mcflugen Apr 6, 2017
7c01679
Skip all unexpanded notebooks.
mcflugen Apr 6, 2017
65528e5
Add multiple skip options.
mcflugen Apr 6, 2017
68cf2af
Remove linux builds.
mcflugen Apr 6, 2017
50eee06
Skip notebooks that are not passing yet.
mcflugen Apr 6, 2017
0631985
Add try/except to catch error.
mcflugen Apr 6, 2017
ad15744
Clean up code.
mcflugen Apr 6, 2017
8981e56
Add try/except to catch error.
mcflugen Apr 7, 2017
c2e18d1
Run the fields notebook.
mcflugen Apr 7, 2017
3926547
Add a brief CONTRIBUTING doc.
mcflugen Apr 7, 2017
2c0fd4d
Import print_function from the future.
mcflugen Apr 7, 2017
abfbd15
Merge branch 'mcflugen/test-notebooks' of github.com:landlab/tutorial…
mcflugen Apr 7, 2017
f96b62d
Remove unexpanded notebooks.
mcflugen Apr 7, 2017
8dc3f33
Remove redundant python scripts.
mcflugen Apr 7, 2017
3d8d068
Do not skip *_unexpanded.ipynb - they don't exist.
mcflugen Apr 7, 2017
7670c71
Add Travis CI badge [skip ci].
mcflugen Apr 7, 2017
d327df5
Add option to read notebooks from a file.
mcflugen Apr 10, 2017
13f0b43
Add script to find notebooks.
mcflugen Apr 10, 2017
ae9148f
Use new script to find notebooks.
mcflugen Apr 10, 2017
ed70ecf
Remove unexpanded notebooks.
mcflugen Apr 10, 2017
fe82461
Use print function.
mcflugen Apr 10, 2017
6f45664
Use print function.
mcflugen Apr 10, 2017
3f38413
Remove pyc files.
mcflugen Apr 10, 2017
b82c995
Fix bug when notebook doesn't have a dir part.
mcflugen Apr 10, 2017
98d01cc
Use load_params function to read input.
mcflugen Apr 10, 2017
714c815
Change name of skip option to exclude.
mcflugen Apr 10, 2017
62ec2eb
Remove unused ci files.
mcflugen Apr 10, 2017
481c613
Use --exclude option.
mcflugen Apr 10, 2017
c527c1b
Combine scripts.
mcflugen Apr 10, 2017
6170d65
Add script to find and run all tests.
mcflugen Apr 10, 2017
58d31d5
Set backend to Agg in matplotlibrc; Build on linux.
mcflugen Apr 10, 2017
0dda346
Comment out matplotlib magic.
mcflugen Apr 10, 2017
dcb623d
Make MPLCONFIGDIR then create matplotlibrc.
mcflugen Apr 10, 2017
e3d8160
Quote line that contains a colon.
mcflugen Apr 10, 2017
cdabc91
Track png files.
mcflugen Apr 10, 2017
3548515
Add build for Python 3.6.
mcflugen Apr 11, 2017
a4d8429
Remove unexpanded notebook.
mcflugen Apr 11, 2017
9051417
delete untitled.txt
nicgaspar Apr 11, 2017
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions .ci/header.txt

This file was deleted.

19 changes: 0 additions & 19 deletions .ci/notebook_to_script.py

This file was deleted.

66 changes: 0 additions & 66 deletions .ci/run_tutorials.py

This file was deleted.

18 changes: 0 additions & 18 deletions .ci/travis/install_python.sh

This file was deleted.

1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,4 @@
.DS_Store

*.out
*.png
*.pyc
35 changes: 30 additions & 5 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,18 +1,43 @@
env:
matrix:
- TRAVIS_PYTHON_VERSION="2.7"
- TRAVIS_PYTHON_VERSION="3.4"
- TRAVIS_PYTHON_VERSION="3.5"
- TRAVIS_PYTHON_VERSION="3.6"
global:
- CONDA_PREFIX=$HOME/miniconda
- MINICONDA_URL_BASE="https://repo.continuum.io/miniconda/Miniconda3-latest"
- MPLCONFIGDIR=$HOME/.config/matplotlib
os:
- linux
- osx
sudo: false
before_install:
- |
if [[ $TRAVIS_OS_NAME == "osx" ]]; then
brew remove --force $(brew list)
brew cleanup -s
rm -rf $(brew --cache)
fi
install:
- echo "Build on $TRAVIS_OS_NAME for Python $TRAVIS_PYTHON_VERSION"
- bash .ci/travis/install_python.sh
- export PATH="$HOME/miniconda/bin:$PATH"
- conda install -q -c https://conda.anaconda.org/landlab/label/dev landlab
- |
if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then
OS="MacOSX-x86_64"
else
OS="Linux-x86_64"
fi
- curl $MINICONDA_URL_BASE-$OS.sh > $HOME/minconda.sh
- bash $HOME/minconda.sh -b -p $CONDA_PREFIX
- export PATH="$CONDA_PREFIX/bin:$PATH"
- hash -r
- conda config --set always_yes yes --set changeps1 no
- conda install python=$TRAVIS_PYTHON_VERSION
- conda install scripting -c csdms-stack
- conda install landlab jupyter -c landlab
- conda info -a && conda list
script:
- python .ci/run_tutorials.py
- mkdir -p $MPLCONFIGDIR
- "echo backend: Agg > $MPLCONFIGDIR/matplotlibrc"
- ./run-all-tests.sh
virtualenv:
system_site_packages: false
102 changes: 102 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
[![Build
Status](https://travis-ci.org/landlab/tutorials.svg?branch=master)](https://travis-ci.org/landlab/tutorials)

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

Most of these Landlab tutorials can either be read as text files or run as interactive IPython notebooks (recommended!).
Expand Down
25 changes: 0 additions & 25 deletions boundary_conds/set_BCs_from_xy.py

This file was deleted.

Loading