Contains all the Jupyter Notebooks used in our research.
yyyy-mm-dd_initials_dash-separated-notebook-description Example: 2019-02-22_JFJ_meta-labels.
- Explore only ONE idea.
- Notebooks must be independent, no Notebook-chaining!
- Cells must successfully and correctly execute in order using the "Run all cells" command.
- A notebook should run "as is" if pulled from Git. That is, notebooks may not depend on files on your local computer.
- Remove unused or commented out code.
- Remove empty cells.
- Remove imports that are not used in the notebook.
- Code must be PEP8 compliant.
- Notebooks must not contain duplicate code that exists in another notebook. Rather write a function in a common library.
- Label figures: include a title, axes descriptions and legends.
- Explain the figure.
- Keep it short (~300 lines of code).
- Cells should be short.
- Have reasonable cell outputs.
- Include an abstract, introduction, conclusion and next steps section at the beginning of your notebook. These sections should be written in such a way that, in 3 months from now, it is still clear what the notebook's purpose is without reading any other notebooks.
- Functions in the notebook must have (at least) a one-liner doc string describing that function.
- Complex functions should have toy examples demonstrating purpose and functionality.
- Pull requests for a notebook must include an update to the solution_document.md file detailing your findings.
