Proper notebook headers

markovmodel / pyemma_tutorials

How to analyze molecular dynamics data with PyEMMA

Creative Commons Attribution 4.0 International

72 stars 35 forks source link

Proper notebook headers #52

Closed cwehmeyer closed 6 years ago

cwehmeyer commented 6 years ago

We should clean up the notebook headers and provide some general information, e.g.:

very brief content/aim description
license
maintainer/author(?)

thempel commented 6 years ago

@cwehmeyer, you already included the license into all of the notebooks, right? @marscher @psolsson @cwehmeyer: Should we include maintainer/author?

Finally, let's organize this since it affects all notebooks:

[x] 01-data-io-and-featurisation
[x] 02-dimension-reduction-and-discretisation
[x] 03-msm-estimation-and-validation
[x] 04-msm-coarse-graining-and-analysis
[x] 05-hidden-markov-state-models
[x] 06-expectations-and-observables
[x] 07-vamp-based-feature-selection
[x] 08-common-problems

cwehmeyer commented 6 years ago

@cwehmeyer, you already included the license into all of the notebooks, right?

Yes the license is included but still a bit messy.

@marscher @psolsson @cwehmeyer: Should we include maintainer/author?

I think that would be helpful.

marscher commented 6 years ago

we should mention the usage of docstrings/documentation website in the header. Just a link to the documentation and a quick sentence on how to show docstrings in jupyter would be sufficient.