First of all, thank you for hosting a tutorial through the Project Pythia Python Tutorial Seminar Series. Project Pythia appreciates your support, your work, and commitment to community.
To add your tutorial directory please follow these steps:
If this is your first time hosting a tutorial through the Project Pythia Tutorial Seminar Series, you will need to be added as a member of the Project Pythia Tutorials organization before you can create a new repository. Please let us know if you need to be invited to this organization by emailing [email protected].
To create a new repository, go to the Project Pythia Tutorials organization page, and under "Repositories" select the green "New" button. The first option on the "Create a new repository" page asks whether you'd like to use a repository template. In the dropdown menu select "ProjectPythiaTutorials/tutorial-template" as the template.
Next you'll add your repository name. Use the naming convention TOPIC_YYYY_MM_DD (e.g. pandas_2021_11_24). If you have multiple tutorials in a series that build off of each other, please create multiple repositories that represent the state of the series at each lesson (e.g. pandas_part1_2021_11_24 and pandas_part2_2021_12_08).
Add a brief description and set the repository to Public. Click the "Create repository" button.
The tutorial notebook template is designed to give you a brief overview of what is expected of a Project Pythia Tutorial seminar. We hope you find the template a useful reminder of good presentation ideas and bookendsl. It is not designed to be restrictive or time-consuming if you choose to adapt your material to it.
Add any relevant .ipynb files to the /tutorials/ directory of your repository and any data to the /data/ directory (if the data is too large to store on GitHub, i.e. over the 100 MB limit per file, please indicate this in a /data/README.md file).
Because we understand that you may be editing your notebook right up until your tutorial, the contribution "barrier for entry" in this repository is lower than elsewhere in the Pythia ecosystem. And since you will only be editing files in your new directory, feel free to push directly without waiting for a review.
Every tutorial has environment file. Please check the environment.yaml file to make sure all of your necessary dependencies are listed.
To set up Binder, navigate to mybinder.org. In the "Build and launch a repository" GUI, past the URL link to your new tutorial repository. Binder will be enabled from your environment.yaml file. Then you can launch or copy the Binder link (to be posted in your repository 'README.md').
Every tutorial repository is intended to be accompanied by a README.md markdown file. The contents of this file are similar to what should go out with an announcement of your seminar: title, speaker name, a brief speaker bio, live time and date, and any past tutorials that this new seminar is a continuation of. After the session a member of the Pythia team will embed the Youtube recording into this same file. Please see the README_template.md file for assistance.
You may also merge this new markdown content without waiting for an approval on your pull request.
If you would like to host a tutorial through the Project Pythia Tutorial Seminar Series, please reach out to us here on GitHub or by emailing [email protected].