Ipython notebook is a documentation/tutorial format combined with an interactive python shell. It allows the author to give example source code, which can later be modified and tinkered with by the reader, and subsequently run in-place in the document to update figures or shell output. It is the perfect tool to create a learning platform for a new library and to make the good even better, it is all based on python so should be the perfect match to use in splipy.
Due to limitations on github, the interactive part of this is not present when viewing files here, but if you open these files locally they should be interactive.
VikingScientist
commented
7 years ago
Ipython notebook is a documentation/tutorial format combined with an interactive python shell. It allows the author to give example source code, which can later be modified and tinkered with by the reader, and subsequently run in-place in the document to update figures or shell output. It is the perfect tool to create a learning platform for a new library and to make the good even better, it is all based on python so should be the perfect match to use in splipy.
The IPython Notebook website: https://ipython.org/ipython-doc/1/interactive/notebook.html
Examples of how this can be used on github: https://github.com/akva2/machine_learning_introduction
Due to limitations on github, the interactive part of this is not present when viewing files here, but if you open these files locally they should be interactive.