These are standards that we came up with at Osmo Systems to allow technicians to use Jupyter notebooks to run experiments, while maintaining quality standards to avoid bugs and promote readability and reusability.
Each experiment we did was saved in a shared Google Drive folder, which contained a README entry point and any supporting notebooks and other files.
- In general, see Code Style Manifesto
- Write code conforming to Pep8, e.g. imports, top-level constants
- Black code formatting is preferred. You can add a black formatting button to your notebook with this tool.
- Self-documentation: Someone else (or yourself in 3 months) should be able to open the notebook and know wtf is going on and why. Note: your README is the standard entry point for understanding the experiment at a high level (so that you don’t need jupyter to understand the purpose and basi