Skip to content

Fix notebook CI testing#10

Merged
mcflugen merged 53 commits intomasterfrom
mcflugen/test-notebooks
Apr 12, 2017
Merged

Fix notebook CI testing#10
mcflugen merged 53 commits intomasterfrom
mcflugen/test-notebooks

Conversation

@mcflugen
Copy link
Copy Markdown
Member

This pull requests fixes our CI testing of the tutorial notebooks.

Some highlights:

  • run_notebook.py to find and run notebooks.
  • tutorial_template.ipynb provides a template for new tutorials.
  • Testing for Python 2.7 and 3.5 and 3.6 on Mac and Linux.
  • CONTRIBUTING.md gives a brief outline about how to contribute to the landlab tutorials, including how the write new tutorials.
  • Removed *_unexpanded.ipynb and .py versions of notebooks.

@nicgaspar
Copy link
Copy Markdown
Contributor

@mcflugen This is looking great. I love the contributing docs and love the emojis - both your use and the description of proper emoji use - had no idea that was even a thing. Should we highlight that this doc exists? Maybe in the README?

And, there should no longer be unexpanded notebooks, right? I found one, so I can just delete it from this branch, right? I also found another empty file that I will boot. Otherwise seems great.

@mcflugen
Copy link
Copy Markdown
Member Author

Thanks. I removed the unexpanded notebook (under fault_scarp). If you could remove the empty file, that would be great!

Glad you like the emojis. I went a little overboard. We don't need to follow the emoji usage guidelines but I thought it was fun. It would also make it easier to categorize our commits if we were to make a change log or to skip CI testing for certain cases (like just documentation changes, for example).

@nicgaspar
Copy link
Copy Markdown
Contributor

What about referring to the CONTRIBUTING doc in the README? Do you think people will find it? I may underestimate people.

@mcflugen
Copy link
Copy Markdown
Member Author

That's a good idea.

GitHub is smart enough to see that our repository has a file called CONTRIBUTING.md and, when someone creates a pull request or a new issue, will display a link to that document in a nice big box at the top of the page.

@nicgaspar
Copy link
Copy Markdown
Contributor

Oh, well never mind then. I didn't know, but guessed it was something special given the all caps which I know you hate. I will commit.

@nicgaspar
Copy link
Copy Markdown
Contributor

I will wait for tests to finish...

@mcflugen mcflugen merged commit 7e56364 into master Apr 12, 2017
@mcflugen mcflugen deleted the mcflugen/test-notebooks branch April 12, 2017 14:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants