Giter Site home page Giter Site logo

ds-progress-journal's Introduction

Binder

DS-Progress-Journal

Template for a beginner project in the UCSB Data Science Club.

Allows members to log progress in an interactive visualization using Jupyter Notebook, Pandas, Matplotlib, and mplcursors.

Overview

Being in an academic club like the Data Science Club is very appealing to potential employers. However, one issue with the large number of people listing "UCS Data Science Club" on their resumé is that it can be difficult to quantify the amount of progress made or knowledge gained in this extracurricular club.

This short project intends to help those motivated and driven members of the club to track their weekly progress in a matplotlib visualization, while in the process also gaining knowledge of git commands.

The final result is an interactive visualization like this: example

Create Github Repository

We'll be using this Git Cheat Sheet to help us out.

1. Create GitHub account (if you haven't already)

2. Link GitHub account to terminal/shell

  • In the future, we want to be able to interact with our GitHub scripts through our terminal. In order to do this, we need to point git (the programming language upon which GitHub is based on) to our account.
  • Run git config --global user.name "Your name here" and git config --global user.email "Your email here" in your terminal.
  • To ensure these config commands worked, run git config user.name

3. Fork this repository

  • Forking is the process of copying a repo. To do so, click the "Fork" button at the top right of this screen, next to "Watch" and "Star".

4. Create a local clone

  • Cloning allows us to have a local copy of all the files in the repo which we can make changes to.
  • Hit the profile button in the top right of this page. From that drop-down, select "My Repositories" and find the "DS-Progress-Journal" repo you just cloned. helpful image helpful image
  • Copy the url of your forked repo. It should be https://github.com/YOUR_USERNAME/DS-Progress-Journal
  • In your terminal, navigate to a local directory where you want to store this project. For example, if you have a folder on your desktop called "DataScienceClub", you would type cd desktop/DataScienceClub for Macs, and cd C:\Users\MyName\Desktop\DataScienceClub for Windows.
  • Once in your desired local directory, enter git clone https://github.com/YOUR_USERNAME/DS-Progress-Journal. Make sure you don't just copy and paste that command and actually use your updated username.

5. Edit repo and push changes

  • Now, you're ready to do work in the local repo you just cloned. In the future, you're going to need to update the Github version of the repo to the version on your computer.
  • Once you've made certain changes, it's typically a 3-step process to push changes (update) the Github repo:
    1. git add -A adds all changes, deletions and insertions made to the repo locally
    2. git commit -m "YOUR-MESSAGE" adds a custom commit message where you describe the changes that have been made
    3. git push pushes all staged commits
  • IMPORTANT: In future collaborative work done on Github, you have the potential to make people very angry by pushing directly to master. Read up on branches and experiment on your own time within a personal repo with creating and merging branches.

Install Dependencies

1. Navigate to the directory where the repo is stored locally to your computer

2. Type pip install -r requirements.txt.

  • What's happening with this command is that, line-by-line, the neccessary modules for completing this project are being installed. Depending on your local python setup, you may need to specify pip3 instead of just plain pip.

Open Jupyter Notebook

For this section, check out this guide on installing Jupyter Notebook. It's reccomended that, if you are a beginner, you install Anaconda as a package manager.

1. On your terminal, change your directory to where you stored the DS-Progress-Journal repo

2. Type jupyter notebook to start a new notebook session

3. Click the 'ProgressJournal.ipynb' file to open and begin working.

  • If, for whatever reason, the first cell importing all the dependencies fails, contact a Data Science Officer to help get everything set up right.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.