Using open source tools to refactor geoscience education

Slide 1

Slide 1 text

Using open source tools to refactor geoscience education Lindsey Heagy & GeoSci Team

Slide 2

Slide 2 text

learn some things my story write a thesis?! electromagnetics archive go on tour (not me) geophysics textbook introductory course SimPEG me

Slide 3

Slide 3 text

story

Slide 4

Slide 4 text

story + learning & teaching

Slide 5

Slide 5 text

currently learning & teaching

Slide 6

Slide 6 text

currently learning & teaching

Slide 7

Slide 7 text

currently learning & teaching

Slide 8

Slide 8 text

currently learning & teaching

Slide 9

Slide 9 text

No content

Slide 10

Slide 10 text

● 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

Slide 11

Slide 11 text

this is a problem currently

Slide 12

Slide 12 text

learn some things our story write a thesis?! electromagnetics archive go on tour (not me) geophysics textbook introductory course SimPEG me

Slide 13

Slide 13 text

starting points

Slide 14

Slide 14 text

starting points

Slide 15

Slide 15 text

starting points

Slide 16

Slide 16 text

starting points

Slide 17

Slide 17 text

starting points http://simpeg.xyz

Slide 18

Slide 18 text

● 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

Slide 19

Slide 19 text

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

Slide 20

Slide 20 text

No content

Slide 21

Slide 21 text

refactoring separate style and data my_data html + css + javascript + text

Slide 22

Slide 22 text

refactoring separate style and data html = sphinx(my_data, style='nicer') html + css + javascript + text

Slide 23

Slide 23 text

refactoring capture inputs and functions

Slide 24

Slide 24 text

refactoring change inputs

Slide 25

Slide 25 text

refactoring test functions

Slide 26

Slide 26 text

refactoring ● human readable ● explorable ● testable

Slide 27

Slide 27 text

No content

Slide 28

Slide 28 text

Page: ● Title ● Contributors ● Purpose ● Introduction ● Content ● Images ● Movies!

Slide 29

Slide 29 text

what is a base class? refactoring

Slide 30

Slide 30 text

what is a base class? refactoring (is champion) thanks matplotlib!

Slide 31

Slide 31 text

practices

Slide 32

Slide 32 text

7 step framework for Case Histories define and inherit structure refactoring

Slide 33

Slide 33 text

define and inherit structure refactoring http://disc2017.geosci.xyz

Slide 34

Slide 34 text

refactoring ● organization ● template ● collaborate

Slide 35

Slide 35 text

refactoring

Slide 36

Slide 36 text

refactoring don’t repeat

Slide 37

Slide 37 text

No content

Slide 38

Slide 38 text

refactoring introspect ● Conceptual requirements ● Inheritance

Slide 39

Slide 39 text

refactoring

Slide 40

Slide 40 text

refactoring

Slide 41

Slide 41 text

● licensing ● dependencies ● versioning refactoring

Slide 42

Slide 42 text

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

Slide 43

Slide 43 text

No content

Slide 44

Slide 44 text

No content

Slide 45

Slide 45 text

No content

Slide 46

Slide 46 text

Slide 47

Slide 47 text

capture share http://geosci.xyz

Slide 48

Slide 48 text

(end) Except where noted, this work is licensed under a Creative Commons Attribution 4.0 International License