ECS 171 Project

This repository has two components: the report and the code, under folders report and code.

Code

The code includes all the models, data visualization, and the webapp.

Requirements

The requirements for running the code are given in requirements.txt. Since there are a lot of requirements, we recommend using a virtual environment. To create a virtual environment and install the requirements, follow these commands in the top-level project directory:

For Unix/MacOS

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

Usage

Web App

To run the web app, first change your working directory to code. Then, run python3 frontend/app.py.

Other code

To run the other code, simply call the python interpreter or run the Jupyter notebook.

Report

The report is the 8-10 page final report formatted according to IEEE guidelines. The content of the report is split into .tex files under report/src.

Requirements

Refer the requirements from latex-workshop.

For Windows

You can use either MiKTeX or TeX Live. Install as instructed.

For macOS

Install MacTeX as instructed from the website.

For Linux

Install the required package for pdflatex and bibtex according to your chosen distro.

For Ubuntu:

sudo apt-get -qq update && sudo apt-get install -y --no-install-recommends \
    dvipng texlive-latex-recommended \
    texlive-fonts-recommended \
    texlive-latex-extra \
    texlive-fonts-extra \
    texlive-bibtex-extra biber xzdec

For Manjaro:

pacman -Syu texlive-core texlive-fontsextra texlive-latexextra texlive-science texlive-bibtexextra biber

Usage

To build the project report and open it, change your working directory to report and use the provided makefile.

For Linux

cd report
make