search

BlueBrain / nmodl

Code Generation Framework For NEURON MODeling Language
https://bluebrain.github.io/nmodl/
Apache License 2.0
57 stars 15 forks source link

Compile Jupyter notebook as part of CI #30

Open pramodk opened 5 years ago

pramodk commented 5 years ago

In order to test API of python bindings we should compile/run jupyter notebooks as part of CI. Reference commands from STEPS are here: https://github.com/CNS-OIST/STEPS_Docker/blob/master/recipe/Dockerfile#L72

tristan0x commented 5 years ago

Here are the checks I would perform on every Jupyter notebook:

  1. rebuild the notebook to make sure that cells are executed in the proper order and output is consistent. 1. ensure that the notebook did not change (git diff --quiet), raise an error otherwise
  2. format the notebook with clean-ipynb
  3. ensure that the notebook did not change (git diff --quiet), raise an error otherwise
  4. perform static analysis check with flake8 and/or pylint. Here is an interesting post to check a Jupyter notebook with flake8