Skip to content

Commit 3f996d9

Browse files
committed
Restore jupytercon tutorial readme
1 parent e3153fb commit 3f996d9

File tree

1 file changed

+39
-4
lines changed

1 file changed

+39
-4
lines changed

README.md

Lines changed: 39 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,42 @@
1-
# Tools for managing a collection of notebooks
1+
# JupyterCon Tutorial
22

3-
## Credit and license
3+
[JupyterCon](https://jupytercon.com) will use this template to create a new repository for each tutorial, with speakers added as collaborators.
44

5-
Some of these tools (and all of the idea for them) is from [Jake VanerPlas](https://jakevdp.github.io/)'s [Python Data Science Handbook](https://github.com/jakevdp/PythonDataScienceHandbook).
5+
We also include here [instructions for tutorial speakers](https://github.com/jupytercon/tutorial2020/blob/master/Tutorial_Speakers_Guide.md).
6+
Please follow these instructions carefully, and email us if you have questions: [[email protected]](mailto:[email protected])
67

7-
The files `add_navigation.py` and `generate_contents.py` are modified from the same files in the Handbook, whose code license, a copy of which is in [licenses/LICENSE-CODE](licenses/LICENSE-CODE).
8+
You can delete this file (or rename it) and replace it by a README file that targets the contents of this repository, populated with your tutorial materials.
9+
10+
## Tutorial Chairs for 2020
11+
12+
- Tania Allard, Microsoft
13+
- Gerard Gorman, University College London
14+
15+
## General information
16+
17+
JupyterCon 2020 is an online event that places heavy emphasis on providing learning opportunities for all participants.
18+
It is a project of [NumFOCUS](https://numfocus.org), with a fully volunteer team of organizers.
19+
20+
### What is NumFOCUS?
21+
22+
> NumFOCUS is a 501(c)-3 non-profit in the United States.
23+
Its mission is to promote open practices in research, data, and scientific computing by serving as a fiscal sponsor for open source projects and organizing community-driven educational programs.
24+
NumFOCUS envisions an inclusive scientific and research community that utilizes actively supported open source software to make impactful discoveries for a better world.
25+
26+
## Format for tutorials
27+
28+
Tutorials will consist of on-demand video presentations, and written materials presented in Jupyter notebooks.
29+
The notebooks should be complete and polished, amply narrated worked-out examples and exercises for participants.
30+
31+
Tutorial basic format:
32+
33+
- Three or four Jupyter notebooks (at minimum), each notebook corresponding to "one lesson" – printed, estimate between 10–20 pages, or 17 to 35 min to read, per notebook.
34+
- Estimate for the material to be 1.5 to 3 hours to work through interactively.
35+
- The notebooks are complemented with videos, 25–30 min in length (not longer); at least one video per notebook.
36+
- Optional exercises for participants, instrumented for auto-grading.
37+
- One full tutorial may add up to total-time-on-task by the learners of about 4.5 hours.
38+
39+
## License
40+
41+
The source materials for JupyterCon tutorials are copyright of their authors.
42+
We ask that materials be shared under standard public licenses. We recommend code be under BSD-3 or MIT license, and other materials be under a CC-BY Creative Commons Attribution license.

0 commit comments

Comments
 (0)