One of the best features of any scikit tool is the amount of easy to follow examples that they have for the functions implemented in the library.
I was thinking about adding a simple example along with any relevant function that is implemented in the library. These examples can be added to the examples directory as jupyter notebooks, since they are easily interpreted by GitHub.
The structure of the jupyter notebook should be:
A first cell with the title and at least a short description of the example, in markdown
A second cell with the relevant imports of the skreflectometry library and matplotlib
The third cell should be the loading and processing of the relevant data
The fourth cell should plot the processed data with the default matplotlib styles. No need for fancy LaTeX labels, for example.
One of the best features of any scikit tool is the amount of easy to follow examples that they have for the functions implemented in the library. I was thinking about adding a simple example along with any relevant function that is implemented in the library. These examples can be added to the
examplesdirectory as jupyter notebooks, since they are easily interpreted by GitHub.The structure of the jupyter notebook should be:
skreflectometrylibrary andmatplotlibmatplotlibstyles. No need for fancy LaTeX labels, for example.What do you think?