Skip to content

Latest commit

 

History

History
115 lines (83 loc) · 3.62 KB

README.md

File metadata and controls

115 lines (83 loc) · 3.62 KB
Raw

crash-course

Collection of materials to bring new members of SUSA @ Berkeley up to speed. Hosted by and maintained by the Statistics Undergrad Student Association (SUSA).

Basics

All the code in this repository is expected to run on Python 3.6+

Various libraries needed to execute code samples and jupyter notebooks are listed in requirements.txt

If using conda, one can also use conda.txt to create the corresponding conda env. Then install the pip requirements.

conda create --name NAME --file conda.txt

To then download the libraries efficiently using pip, download this repository, and run

pip3 install -r requirements.txt

Todo

These are a few core topics that we could use help writing tutorials on. In general, feel free to pull request any material you believe is relevant. Worst-case scenario, we just work with you to change a few lines or something.

Notes:

We assume basic Python 3.5/3.6+ proficiency because so many people know it as a result of Data 8 & CS 61a. However, we do not expect any R proficiency.

Areas of Contribution

  • Basics
    • R
    • Bash (Shell scripting)
  • Python
    • Web Scraping (BeatifulSoup4)
    • OS Scripting (Managing packages, working with directories)
  • Data Science
    • Python:
      • Numpy
      • Pandas
      • Sci-Kit Learn
      • Matplotlib (and related imaging libraries)
    • R:
      • Literally I have no clue
  • Deep Learning
    • Python:
      • Tensorflow
      • Keras
      • And models: CNNs, LSTMs, etc
    • R:
      • Again I have no clue

Contributing to This Repository

Assistance is welcome. In order to modify this repo, you first need to know your organization status. You can be

  1. In the susa-org organization
  2. In susa-org and a member of the crashcourse team w/i the org
  3. Not in susa-org

If you are in the susa-org and in the crashcourse team (2)

Your steps for contributing are:

  1. Clone this repo
# Navigate to your directory to store SUSA repositories.
git clone https://github.com/SUSA-org/crash-course.git
  1. Create a new branch for your work
git checkout -b yourbranchnamehere
  1. Upon making your edits, push onto working branch
git add changedfile1 [changedfile2 ...]
git commt -am "Description of change here"
git merge
  1. directly pull/push to this repo

If you are having trouble pulling, pushing to the repo, then it may be because the upstreams are set to be the actual repo. To confirm this, you can run git remote -v and look for (upstream) listed somewhere. Then you just run git pull upstream [working_branch] and git push upstream [working_branch] (from your master branch).

If you are not in the susa-org organization, or you are just a general member (1 or 3)

Your steps for contributing are:

  1. Fork this repo
  2. Clone your fork (www.github.com/youracct/crash-course)
  3. Set your remotes

This means setting up your local version of the repo to be able to pull directly from the actual repo. This can be done by running the following command from within your local git repo:

git remote add upstream https://github.com/SUSA-org/crash-course.git

The link may be wrong, but otherwise it should work. Then, upon running

git remote -v

You should see "upstream https://...." listed.

  1. Pull from the upstream, push to origin
git pull upstream BRANCH # BRANCH is usually master
git push # This will push to your local version, and will push to whatever branch you're working on
  1. Create a pull request (go to your github account's fork, click pull request, compare forks)