Skip to content

Commit cd4540d

Browse files
jfschaeperjfschaeper
committed
First version of new website
1 parent a0d00d1 commit cd4540d

18 files changed

+560
-0
lines changed

‎.github/workflows/deploy.yaml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Publish docs via GitHub Pages
2+
on:
3+
push:
4+
branches:
5+
- master
6+
- main
7+
permissions:
8+
contents: write
9+
jobs:
10+
deploy:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v3
14+
- uses: actions/setup-python@v4
15+
with:
16+
python-version: 3.x
17+
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
18+
- uses: actions/cache@v3
19+
with:
20+
key: mkdocs-material-${{ env.cache_id }}
21+
path: .cache
22+
restore-keys: |
23+
mkdocs-material-
24+
- run: pip install mkdocs-material
25+
- run: mkdocs gh-deploy --force

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
site/*

‎.vscode/settings.json

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
{
2+
"cSpell.words": [
3+
"Bioinformatics",
4+
"Blas",
5+
"CRAN",
6+
"Chromedriver",
7+
"Homebrew's",
8+
"Lachlan",
9+
"OLAT",
10+
"Pandoc",
11+
"Pearce",
12+
"Snakemake",
13+
"Stata",
14+
"Whitespacer",
15+
"chmod",
16+
"citool",
17+
"difftool",
18+
"dpkg",
19+
"fsck",
20+
"gdebi",
21+
"gitcompletion",
22+
"gitk",
23+
"gnutls",
24+
"instaweb",
25+
"johnsmith",
26+
"libappindicator",
27+
"libcurl",
28+
"libgit",
29+
"libindicator",
30+
"libopenblas",
31+
"librtmp",
32+
"libssl",
33+
"libxml",
34+
"libxss",
35+
"linearmodels",
36+
"markdownlint",
37+
"mergetool",
38+
"msgpack",
39+
"openssl",
40+
"prepend",
41+
"reflog",
42+
"rmarkdown",
43+
"rstudio",
44+
"shortlog",
45+
"shortname",
46+
"spacebar",
47+
"spearce",
48+
"submodule",
49+
"ubergmann",
50+
"virtualenvwrapper",
51+
"whatchanged",
52+
"worktree",
53+
"xcode",
54+
"xvfb"
55+
],
56+
"spellright.language": [
57+
"en_US"
58+
],
59+
"spellright.documentTypes": [
60+
"markdown",
61+
"latex",
62+
"plaintext"
63+
]
64+
}

‎CONDUCT.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Contributor Code of Conduct
2+
3+
As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
4+
5+
We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
6+
7+
Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
8+
9+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
10+
11+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
12+
13+
This Code of Conduct is adapted from the Contributor Covenant (http://contributor-covenant.org), version 1.0.0, available at http://contributor-covenant.org/version/1/0/0/

‎CONTRIBUTING.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Contributing
2+
3+
[Programming Practices for Research in Students](https://github.com/pp4rs) is an open source project,
4+
and we welcome contributions of all kinds:
5+
new lessons,
6+
fixes to existing material,
7+
bug reports,
8+
and reviews of proposed changes are all welcome.
9+
10+
## Contributor Agreement
11+
12+
By contributing,
13+
you agree that we may redistribute your work under [our license](LICENSE.md).
14+
In exchange,
15+
we will address your issues and/or assess your change proposal as promptly as we can,
16+
and help you become a member of our community.
17+
Everyone involved
18+
agrees to abide by our [code of conduct](CONDUCT.md).
19+
20+
## Using GitHub
21+
22+
If you choose to contribute via GitHub, you may want to look at
23+
[How to Contribute to an Open Source Project on GitHub][how-contribute].
24+
To manage changes, we follow [GitHub flow][github-flow].
25+
Each lesson has one or two maintainers who review issues and pull requests or encourage others to do so.
26+
The maintainers have final say over what gets merged into the lesson.
27+
To use the web interface for contributing to a lesson:
28+
29+
1. Fork the originating repository to your GitHub profile.
30+
2. Within your version of the forked repository, move to the `master` branch and
31+
create a new branch for each significant change being made.
32+
3. Navigate to the file(s) you wish to change within the new branches and make revisions as required.
33+
4. Commit all changed files within the appropriate branches.
34+
5. Create individual pull requests from each of your changed branches
35+
to the `master` branch within the originating repository.
36+
6. If you receive feedback, make changes using your issue-specific branches of the forked
37+
repository and the pull requests will update automatically.
38+
7. Repeat as needed until all feedback has been addressed.
39+
40+
When starting work, please make sure your clone of the originating `master` branch is up-to-date
41+
before creating your own revision-specific branch(es) from there.
42+
Additionally, please only work from your newly-created branch(es) and *not*
43+
your clone of the originating `master` branch.
44+
Lastly, published copies of all the lessons are available in the `master` branch of the originating
45+
repository for reference while revising.
46+
47+
[github]: https://github.com
48+
[github-flow]: https://guides.github.com/introduction/flow/
49+
[github-join]: https://github.com/join
50+
[how-contribute]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
51+
[issues]: https://guides.github.com/features/issues/

‎DESCRIPTION

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Lesson: installation-guide
2+
Title: Installation Guide for Programming Practices for Research Students
3+
Version: 2022.0.1
4+
Authors: c(
5+
person("Lachlan", "Deer", email = "lachlan.deer@gmail.com", role = "cre"),
6+
person("Martin", "Stancsics", email = "martin.stancsics@gmail.com", role = "aut")
7+
)
8+
Maintainer: Martin Stancsics <martin.stancsics@gmail.com>
9+
Description: Course Installation Guide. Built using `Mkdocs.` This is the most up to date version.
10+
License: CC-BY-SA
11+
Encoding: UTF-8

‎README.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
<!-- markdownlint-disable MD033 -->
2+
<!-- see https://github.com/DavidAnson/markdownlint for code to enable or disable rules -->
3+
4+
# Module: Installation Guide for Programming Practices for Research Students
5+
6+
[![GitHub Pages](https://github.com/pp4rs/2024-uzh-installation-guide/actions/workflows/deploy.yaml/badge.svg)](https://github.com/pp4rs/2024-uzh-installation-guide//actions/workflows/deploy.yaml)
7+
[![lifecycle](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://www.tidyverse.org/lifecycle/#maturing)
8+
[![lifecycle](https://img.shields.io/badge/version-2024.0-red.svg)]()
9+
10+
11+
## Meta-Information
12+
13+
* Module Maintainer: Julius Schäper (`@jfschaeper`)
14+
* Course: [Programming Practices for Research in Economics](https://pp4rs.github.io)
15+
* Institute: Dept of Economics, Uni Zurich
16+
* Current Version: [Fall 2024 edition](https://pp4rs.github.io/2024-uzh-installation-guide)
17+
18+
## Building the Site
19+
20+
The site is rendered using [MkDocs](https://www.mkdocs.org/) and build using GitHub actions.
21+
22+
If you want to build the site locally on your machine:
23+
24+
* Change your working directory to this one, and then create an environment with the necessary packages:
25+
26+
```{.bash}
27+
conda env create -f environment.yml -n <env_name>
28+
```
29+
30+
* Look at a copy of the site served locally on your machine:
31+
32+
```{.bash}
33+
mkdocs serve
34+
```
35+
36+
* The website will be served at http://127.0.0.1:8000/python/.
37+
38+
If you want to host the website on GitHub pages:
39+
40+
* Change your working directory to this one and run:
41+
```{.bash}
42+
mkdocs gh-deploy
43+
```
44+
45+
* Behind the scenes, MkDocs will build your docs and use the ghp-import tool to commit them to the gh-pages branch and push the gh-pages branch to GitHub.
46+
47+
* Now navigate to 'Settings' in the GitHub repository and make sure 'Build and Deployment' has its source set to 'Deploy from a branch' and choose the 'gh-pages' branch with 'root' as the folder origin.
48+
49+
* After a short period of time the website should be available.
50+
51+
## Want to Contribute
52+
53+
* See the contributing guide [here](CONTRIBUTING.md).
54+
* By contributing you agree to abide by the [Code of Conduct](CONDUCT.md)
55+
56+
## License
57+
58+
All materials are licensed under a Creative Commons CC-SA license. The license allows you to copy, remix and redistribute any of our publicly available materials, under the condition that you attribute the work (details in the license). More information is available [here](http://creativecommons.org/licenses/by-sa/4.0/)
59+
60+
## Suggested Citation
61+
62+
The suggested citation for the course materials is:
63+
64+
``` bash
65+
Julius Schäper, 2024, Installation Guide, Programming Practices for Research in Economics, University of Zurich
66+
```
67+
68+
If you find the installation guide useful - please drop us a line and say so - pp4rs@econ.uzh.ch
69+
70+
<a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a><br />
71+
72+
This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.

‎docs/acknowledgement.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Acknowledgements
2+
3+
This edition of Programming Practices is based on the previous versions of the course. Further information on contributors can be found under "Instructors".
4+
5+
It is designed after and borrows a lot from:
6+
7+
* [`Effective Programming Practices for Economists`](https://wiwi.uni-bonn.de/gaudecker/prog_econ_slides.html#prog-econ-slides), a course by [Hans-Martin von Gaudecker](http://wiwi.uni-bonn.de/gaudecker/index.html)
8+
* Software Carpentry's [`Managing Software Research Projects`](https://swcarpentry.github.io/managing-research-software-projects/) lesson
9+
* [`Data Science for Economists`](https://github.com/uo-ec607), a course by [Grant McDermott](http://grantmcdermott.com/)

‎docs/citation-license.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# License
2+
3+
Material is licensed under a CC-BY-SA license.

‎docs/contact.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Contact Us
2+
3+
Please contact us via email: [pp4rs@econ.uzh.ch](pp4rs@econ.uzh.ch).
4+
5+
We look forward to hearing from you if you have questions about the installation guide, found this installation guide useful, or have further comments or suggestions to improve it.
6+
7+
## Microsoft Teams
8+
9+
Throughout the course we will post useful tidbits of information, and answer questions that are slightly off topic via Microsoft Teams.
10+
11+
[![](https://upload.wikimedia.org/wikipedia/commons/c/c9/Microsoft_Office_Teams_%282018%E2%80%93present%29.svg){: style="width:32px"}](https://teams.microsoft.com/l/channel/19%3a9568a1b5b0eb4c019fd0222030fcb1c7%40thread.tacv2/General%2520(2023)?groupId=a57eafc0-f04b-4d0e-8013-fb868b027728&tenantId=c7e438db-e462-4c22-a90a-c358b16980b3) [Join Our Chat](https://teams.microsoft.com/l/channel/19%3a9568a1b5b0eb4c019fd0222030fcb1c7%40thread.tacv2/General%2520(2023)?groupId=a57eafc0-f04b-4d0e-8013-fb868b027728&tenantId=c7e438db-e462-4c22-a90a-c358b16980b3)
12+
13+
* Log in with your econ.uzh.ch, bf.uzh.ch or uzh.ch email address.
14+
* Join the channel `General (2023)`

‎docs/editions.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Editions
2+
3+
Programming Practices for Research in Economics was launched in 2016.
4+
Links to each version of the Course can be found below.
5+
6+
### 2022 Edition
7+
8+
The Fall 2022 edition will be held August 24 - September 9, 2022 at Uni Zurich.
9+
10+
- [Course Home Page](https://pp4rs.github.io/2022-uzh/)
11+
- [Installation Guide](https://pp4rs.github.io/2022-uzh-installation-guide)
12+
- [Course Syllabus](https://pp4rs.github.io/2022-uzh/assets/pp4rs-syllabus.pdf)
13+
- [Course Material](https://github.com/pp4rs/2022-uzh-course-material)
14+
15+
### 2021 Edition
16+
17+
The Fall 2021 edition will be held September 2 - September 14, 2021 at Uni Zurich.
18+
19+
- [Course Home Page](https://pp4rs.github.io/2021-uzh/)
20+
- [Installation Guide](https://pp4rs.github.io/2021-uzh-installation-guide)
21+
- [Course Syllabus](https://pp4rs.github.io/2021-uzh/assets/pp4rs-syllabus.pdf)
22+
- [Course Material](https://github.com/pp4rs/2021-uzh-course-material)
23+
24+
### 2020 Edition
25+
26+
The Winter 2020 edition will be held January 27 - February 14, 2020 at Uni Zurich.
27+
28+
- [Course Home Page](https://pp4rs.github.io/2020-uzh/)
29+
- [Installation Guide](https://pp4rs.github.io/2020-uzh-installation-guide)
30+
- [Course Syllabus](https://pp4rs.github.io/2020-uzh/assets/pp4rs-syllabus.pdf)
31+
- [Course Material](https://github.com/pp4rs/2020-uzh-course-material)
32+
33+
### 2019 Foundations Edition
34+
35+
The 4-day foundations course will be held from February 13 until February 16 at Uni Zurich.
36+
37+
- [Course Home Page](https://pp4rs.github.io/2019-foundations-uzh/)
38+
- [Installation Guide](https://pp4rs.github.io/foundations-installation-guide)
39+
- [Course Syllabus](https://pp4rs.github.io/2019-foundations-uzh/assets/pp4rs-foundations-syllabus.pdf)
40+
- [Course Material](https://github.com/pp4rs/2018-uzh-course-material)
41+
42+
### 2018 Edition
43+
44+
The 2018 edition will be held August 27 - September 19, 2018 at Uni Zurich.
45+
46+
- [Course Home Page](https://pp4rs.github.io/2018-uzh/)
47+
- [Installation Guide](https://pp4rs.github.io/2018-uzh-installation-guide/)
48+
- [Course Syllabus](https://pp4rs.github.io/2018-uzh/assets/pp4rs-syllabus.pdf)
49+
- [Course Material](https://github.com/pp4rs/2018-uzh-course-material)
50+
51+
### 2017 Edition
52+
53+
The 2017 edition was held from August 28 - September 15, 2017.
54+
55+
- [Course Home Page](https://pp4rs.github.io/2017-uzh/)
56+
- [Installation Guide](https://pp4rs.github.io/2017-installation-guide/)
57+
- [Course Syllabus](https://pp4rs.github.io/2017-uzh/assets/pp4rs-syllabus.pdf)
58+
- [Course Material](https://github.com/pp4rs/2017-uzh-course-material)
59+
60+
### 2016 Edition
61+
62+
The 2016 edition was held from August 29 until September 9, 2016.
63+
64+
- [Course Syllabus](http://github.com/lachlandeer/lachlandeer.github.io/blob/master/static/syllabus-prog-course-2016.pdf)
65+
- [Course Material](#) *(requires a Department of Economics log in)*

‎docs/install_guide.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Installation Guide
2+
3+
Setting up a computer to do computational / statistical resarch is often an intimidating first step. We provide a step-by-step set of instructions for participants on how to install all of the required software for the course. Our instructions provide details for Windows, Mac and Ubuntu flavoured Linux machines.
4+
5+
We use these instructions ourselves when setting up our machines. Let us know if you find the instructions useful for your own work.
6+
7+
If you find errors or explanations that lack clarity, drop us a short email (see Contact page) and we'll do our best to add some clarifiying information.
8+
9+
!!! Note "Installation Help"
10+
Please try and install all the software before the course begins. If you are struggling we are able to help - but we expect you have tried to work through the guide yourself.
11+
12+
We will offer an installation help drop in at the following time:
13+
14+
- Day: August 24
15+
- Time: TBA
16+
- Location: TBA
17+
18+
## Current Installation Guides
19+
20+
Current Version: [2024 Installation Guide](https://pp4rs.github.io/2024-uzh-installation-guide/)
21+
22+
## Archived Installation Guides
23+
We archive all versions of the installation guide so that participants in previous editions have access to how to set up the environment they used during the course.
24+
You can find the the archived course materials [here](https://pp4rs.github.io/editions/).

0 commit comments

Comments
 (0)