intro-curriculum-python

Custom curriculum for teaching Python, the Unix Shell, & Git with an integrated workflow and reproducible research practices.

https://github.com/umcarpentries/intro-curriculum-python

Science Score: 18.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.3%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Custom curriculum for teaching Python, the Unix Shell, & Git with an integrated workflow and reproducible research practices.

Basic Info
Statistics
  • Stars: 0
  • Watchers: 7
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created about 3 years ago · Last pushed over 2 years ago
Metadata Files
Readme Contributing License Code of conduct Citation

README.md

U-M Carpentries Python Curriculum

website License

This is the custom curriculum developed by the University of Michigan Software Carpentry instance. It is in the beta stage of development; we are continuing to host workshops to gather feedback and polish the curriculum.

The rendered website can be found at https://umcarpentries.org/intro-curriculum-python/.

Repo Layout

  1. Top level files
- `index.md` - The home page.
- `reference.md` - Reference for learners.
- `setup.md` - Setup instructions for learners.
- `AUTHORS` - Plain text list of the lesson authors.
- `CITATION` - Plain text citation instructions.
  1. Lesson episodes
- `_episodes/` - Source files in Markdown. Episode order is determined by the filename. Currently the lessons are directly written in the Markdown files inside this folder. 
- `_episodes_ipynb/` - Source files in Jupyter Notebook. 
<!-- - `_episodes_rmd/` - Source files in R Markdown. A lesson should be written in one or the other markdown style, not both. To convert R Markdown files to markdown episodes, run `make lesson-rmd`. -->

<!-- Run `make lesson-check` at any time -->
<!-- to check that the lesson files follow the formatting rules -->
  1. Figures are stored in fig/, data sets in data/, and miscellaneous files in files/.

  2. _extras/

- `about.md` - General notes about the curriculum.
- `discussion.md` - For learners who would like to learn more.
- `guide.md` - The instructor's guide for the curriculum.
- `bonus_exercises.md` - Bonus exercises for learners who want to practice more.

Workshop Schedule

For a typical 2-day workshop. Can be modified for different workshop formats.

| | Title | Source File | |---|-------|-------------| | Day 1 | | | 09:00 | Welcome to the workshop | _episodes/00-intro.md | | 09:15 | Python for Plotting | _episodes/01-python-plotting.md | | 10:30 | Break | | | 10:45 | Python for Plotting (Continued) | continuation of 01-python-plotting.md | | 12:00 | Lunch Break | | | 13:00 | The Unix Shell | _episodes/02-unix-shell.md | | 14:15 | Break | | | 14:30 | Intro to git & GitHub | _episodes/03-intro-git-github.md | | 16:30 | Wrap-up Day 1 | | | Day 2 | | | 09:00 | Python for Data Analysis | _episodes/04-python-data-analysis.md | | 10:30 | Break | | | 10:45 | R for Data Analysis (Continued) | continuation of 04-python-data-analysis.md | | 12:00 | Lunch Break | | | 13:00 | Jupyter Notebook and Markdown | _episodes/05-markdown.md | | 14:30 | Break | | | 14:45 | Jupyter Notebook and Markdown (Continued) | at end of 05-markdown.md | | 16:00 | Conclusions & Wrap-up | _episodes/06-conclusion.md | | 16:15 | Exit Survey | | | 16:30 | End | |

Helpful links

  • The Carpentries lesson example repo: https://github.com/carpentries/lesson-example
  • Already-established SWC curricula: https://github.com/swcarpentry/swcarpentry#lesson-repositories
  • Lesson style guide: https://carpentries.github.io/lesson-example/06-style-guide/index.html
  • Guide to contributing with git and GitHub: https://github.com/dmgt/swcgithubflow/blob/master/fornovicecontributors.md#

Owner

  • Name: UM Carpentries
  • Login: UMCarpentries
  • Kind: organization
  • Location: Ann Arbor, MI

We host Software, Data, & Library Carpentry workshops on the University of Michigan campus

Citation (CITATION.md)

## Citation

If you would like to cite our work, please use:

```
Lapp et al., (2022). Developing and deploying an integrated workshop 
curriculum teaching computational skills for reproducible research. 
Journal of Open Source Education, 5(47), 144, https://doi.org/10.21105/jose.00144
```

Here's a bibtex entry for LaTeX users:

```bib
@article{lapp_developing_2022,
  doi = {10.21105/jose.00144},
  url = {https://doi.org/10.21105/jose.00144},
  year = {2022},
  publisher = {The Open Journal},
  volume = {5},
  number = {47},
  pages = {144},
  author = {Zena Lapp and Kelly Sovacool and Nick Lesniak and Dana King and Catherine Barnier and Matthew Flickinger and Jule Krüger and Courtney Armour and Maya Lapp and Jason Tallant and Rucheng Diao and Morgan Oneka and Sarah Tomkovich and Jacqueline Anderson and Sarah Lucas and Patrick Schloss},
  title = {Developing and deploying an integrated workshop curriculum teaching computational skills for reproducible research},
  journal = {Journal of Open Source Education}
}
```

GitHub Events

Total
  • Watch event: 1
Last Year
  • Watch event: 1

Dependencies

.github/workflows/check-links.yml actions
  • actions/checkout v2 composite
  • actions/upload-artifact v2 composite
  • r-lib/actions/setup-r v1 composite
.github/workflows/draft-pdf.yml actions
  • actions/checkout v2 composite
  • actions/upload-artifact v1 composite
  • openjournals/openjournals-draft-action master composite
.github/workflows/website.yml actions
  • actions/cache v2 composite
  • actions/checkout master composite
  • actions/setup-python v2 composite
  • r-lib/actions/setup-r master composite
  • ruby/setup-ruby v1 composite
Gemfile rubygems
  • github-pages >= 0 development
  • webrick >= 1.6.1
requirements.txt pypi
  • PyYAML *
  • update-copyright *