search

neuro-data-science / neuro_data_science

An open course in neural data science
GNU General Public License v3.0
50 stars 14 forks source link

Quality control for current notebooks #12

Open choldgraf opened 7 years ago

choldgraf commented 7 years ago

Per our previous discussion in #8 , our first step is to standardize the python materials that are already there. We'll perform the following for each week's material:

For each notebook:

  1. Make sure the code works by hitting just "run all"
  2. All chunks of code must be commented
  3. Markdown "context" for sections in-line with code
  4. Visualizations are labeled and display properly
  5. Pythonic code that adheres to PEP8 as much as possible
  6. Underscored variable naming
  7. Breakout sections within notebooks (mid-lecture)
choldgraf commented 7 years ago

Just an update on my end - I just updated the basic python notebooks. Take a look and LMKWYT. Also uploaded as much matlab material as I could find in the original dropbox. That's still quite rough and will need to be cleaned up by somebody one day. I'm going to put the course materials (e.g. pdfs, presentations ,etc) in the data repository.