Skip to content

Files

Latest commit

 Cannot retrieve latest commit at this time.

History

History
16 lines (9 loc) · 957 Bytes

README_notebooks.md

File metadata and controls

16 lines (9 loc) · 957 Bytes

Jupyter notebooks

The content of JupyterCon tutorials should be completely reflected in written materials provided as Jupyter notebooks. Worked out examples should be fully narrated, and no code cells should be left unexplained.

Use a naming convention where each notebook file starts with a number, reflecting the order of the lessons in the tutorial.

List all notebooks in this README.

Add any Python package dependencies to the requirements.txt in the parent directory.

Add a dockerfile if there are additional package dependencies (e.g. Jupyter extensions).

Recommend that all notebooks be shared under a dual license: BSD-3 or MIT license for code, and CC-BY license for text and media.

Recommend GitHub actions are added to test that dependencies install and notebooks can execute successful.