Skip to content

A template of a tutorial repository including content in the `README.md`, a `.ipynb` tutorial template, the environment file, Binder build, and GitHub actions.

Notifications You must be signed in to change notification settings

ProjectPythiaTutorials/tutorial-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

author date tags
Name
YYYY-MM-DD

Thank you for contributing and presenting at a tutorial during the Project Pythia Python Tutorial Series. Please replicate a README.md file similar to this in your tutorial repository. Please edit the content indicated by "[]" to include all relevant information. This template is designed to assist not hinder, you may make additional changes as you see fit. Please reach out to a Project Pythia team member if you need assistance.

[Tutorial Title]

Binder

The Project Pythia Python Tutorial Series continues with [Tutorial Title] on Thursday, [Month Day] at 1 PM Mountain [Daylight/Standard] Time. This session will be led by [Name].

The content for this tutorial is hosted in the .ipynb notebook file(s) within the tutorial directory of this repository. The files include: [topic_a.ipynb and topic_b.ipynb].

[Note: If this is a multiple session tutorial, please indicate that here. Each session of this tutorial will have its own repository within the ProjectPythiaTutorials organization.]

Pre-Requisites

[Are there any pre-requisites for your intended tutorial audience? Please list them here.]

Bio

[Note: Please include a brief bio on yourself and your career path that touches on why you have some authority to present on your tutorial topic. Feel free to mention any hobbies, fun facts, or embed a photo.]

How-to-Run

All of the tutorials in this organization can be followed by clicking the "Launch Binder" button at the top level or in each directory. [Note: Please edit the Binder path to point to your specific tutorial repository.]

You may also download the environment to run locally:

  • Check your conda install with conda --version and if necessary install by following these instructions.

  • Clone this repository by running git clone https://github.com/ProjectPythiaTutorials/[tutorial-template] in your terminal.

  • Still in the terminal, create a Conda environment from the environment.yml file by first moving into the [tutorial-template] directory with cd [tutorial-template] and then conda env update --file environment.yml

  • Activate your environment in the terminal with conda activate [tutorial-template].

  • Test your installation by launching JupyterLab with jupyter lab.

Sign Up

To receive the Zoom link and password, please join the [email protected] Google group and Calendar.

To join the [email protected] Google Group, follow this link and click "Join Group" next to the group name.

By attending this tutorial, you are subject to the NCAR/UCAR Code of Conduct

[Note: If it would be beneficial to review the related tutorials from this series, please link to them here.]

Tutorial Recording

This tutorial will be recorded and posted on our YouTube channel. [Note: A Project Pythia team member will replace this section with the embedded video once it is ready.]

About

A template of a tutorial repository including content in the `README.md`, a `.ipynb` tutorial template, the environment file, Binder build, and GitHub actions.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published