AxelBogos/NHL-Analytics

Repo for Main IFT6758 Project

🏒 IFT-6758 Project

Repo URL

• 👩‍🔬👨‍🔬 Authors
• 👀️ Demo
• 📐 Environment Variables
• ⚙️ Run Locally
• ✒️ Documentation
• ☑️ Milestones
• 📡 Deployment
• 🔨 Appendix

👩‍🔬👨‍🔬 Authors

• @Axel Bogos
• @Marc-André Gagné
• @Van Binh Truong
• @Houda Saadaoui

👀️ Demo

-> See interactive plot in figures/Q6_plot.html
Here's a screenshot of the interactive plot:

-> Blog post repo here!

-> Here's a screenshot of a docker-hosted jupyter notebook which serves as the dashboard in milestone 3.

📐 Environment Variables

• COMET_API_KEY : Your personal API key to use comet.ml. Create a free acount and see Account -> Settings -> Developer Information

⚙️ Run Locally

1. Clone the project

  git clone https://github.com/AxelBogos/IFT6758-Project.git

2. Go to the project directory

  cd project

3. Install virtual environment

conda env create --name YOUR_ENV_NAME --file=environment.yml
conda activate YOUR_ENV_NAME   

4. Get the data (~3.15Gb)

python ift6758/data/data-acquisition.py

5. Run tidy data script (~5-10 min depending on your I/O speed)

python ift6758/features/tidy_dataframe_builder.py

6. Run Plotting Functions

python ift6758/visualizations/plots.py

7. Have fun exploring any notebook and figures in ./notebooks and ./figures

☑️ Milestones

• Milestone 1 - October 15 2021, 11:59PM
• Milestone 2 - November 26 2021, 11:59PM
• Milestone 3 - December 23rd

📡 Deployment

1. Blog post repo here!

2. Clone the project

  git clone https://github.com/MAGjagger/ift6758-Blog.git

3. Go to the project directory

  cd project

4. Execute the server. See here for more details about the jekyll installation.

  bundle exec jekyll serve

🔨 Appendix