Using open source tools to refactor geoscience education

How do we communicate fundamental concepts in a reproducible, actionable form? How do we put numerical simulation tools in the hands of undergraduate students? These are questions we have been exploring in the development of GeoSci.xyz, a web-based resource in geophysics that leverages the geophysical software package SimPEG, Sphinx documentation, Jupyter notebooks and Binders to make examples and explanations that are reproducible and interactive.

Talk available at: https://www.youtube.com/watch?v=IW2LDsevvDk

Transcript

1. Using open source tools to refactor geoscience education Lindsey Heagy & GeoSci Team
2. learn some things my story write a thesis?! electromagnetics archive go on tour (not me) geophysics textbook introductory course SimPEG me
3. story
4. story + learning & teaching
5. currently learning & teaching
6. currently learning & teaching
7. currently learning & teaching
8. currently learning & teaching
10. • Bugs • Reviewed by ~2 people • No discussion / issue board? • How did they make that figure? • Is it Current? out of date? • Limited input / feedback • Reuse is limited ◦ copy paste writing ◦ licensing restrictions • Roadmap? Is there one? • Who do I ask? are there stewards of this work? • Limited collaboration opportunities ◦ 1 or 2 (the good ones have 2) • Diff? What changed in this version? ◦ version 1 is in the used book store and is $100 cheaper. What changed? - only question order? currently
11. this is a problem currently
12. learn some things our story write a thesis?! electromagnetics archive go on tour (not me) geophysics textbook introductory course SimPEG me
13. starting points
14. starting points
15. starting points
16. starting points
17. starting points http://simpeg.xyz
18. • iterate in place • versioned • reproducible • tested • collaborative • track issues • continuous peer review • feedback • interoperable • extensible • multiple media types • ... wouldn’t it be nice capture share
19. practices forking testing deployment licensing versioning issue tracking peer review pull requests tools Travis CI PyPi licenses Google App Engine git Github Sphinx Read the Docs organize refactoring
21. refactoring separate style and data my_data html + css + javascript + text
22. refactoring separate style and data html = sphinx(my_data, style='nicer') html + css + javascript + text
23. refactoring capture inputs and functions
24. refactoring change inputs
25. refactoring test functions
26. refactoring • human readable • explorable • testable
28. Page: • Title • Contributors • Purpose • Introduction • Content • Images • Movies!
29. what is a base class? refactoring
30. what is a base class? refactoring (is champion) thanks matplotlib!
31. practices
32. 7 step framework for Case Histories define and inherit structure refactoring
33. define and inherit structure refactoring http://disc2017.geosci.xyz
34. refactoring • organization • template • collaborate
35. refactoring
36. refactoring don’t repeat
38. refactoring introspect • Conceptual requirements • Inheritance
39. refactoring
40. refactoring
41. • licensing • dependencies • versioning refactoring
42. practices forking testing deployment licensing versioning issue tracking peer review pull requests tools Travis CI PyPi licenses Google App Engine git Github Sphinx Read the Docs organize refactoring
46. • iterate in place • versioned • reproducible • tested • collaborative • track issues • continuous peer review • feedback • interoperable • extensible • multiple media types • ... wouldn’t it be nice capture share
47. capture share http://geosci.xyz
48. (end) Except where noted, this work is licensed under a Creative Commons Attribution 4.0 International License