Skip to content

Latest commit

 

History

History
32 lines (27 loc) · 2.19 KB

README.md

File metadata and controls

32 lines (27 loc) · 2.19 KB
Raw

GRMDS-CrossEntropy

This is a repository containing submissions of team CrossEntropy to the GRMDS Responsible Investing Dashboard Competition

Description

This Dashboard display the statistical summary of invested funds and reports for each stock, starting from their usage allocation, type of sustainability investment, and stock growth over time.

Members

Table of Contents:

Name Details
apps Scripts for pages in the dashboard
data-gathering Python scripts used to gather data using Web Scraping with Beautiful Soup
datasets Processed datasets used for the dashboard. These datasets are provided by RMDS
gathered-dataset Datasets scraped using the scripts from data-gathering
dashboard.py Main code for the dashboard
multiapp.py Helper code to build the multi-page dashboard
requirements.txt List of required modules to run the dashboard
GRMDS_CrossEntropy_Notebook.ipynb Notebook containing most of our analysis
Technical Report GRMDS CrossEntropy.pdf Technical Report for submission in PDF format
Working App The dashboard, deployed on streamlit

Steps of Deployment (in vscode):

  1. Clone this repository
  2. Set up a virtual environment by typing python -m venv env in the command line
  3. Set your interpreter path to the virtual environment path
  4. Download all the dependencies (modules) by typing python -m pip install -r requirements.txt
  5. Type streamlit run dashboard.py in the python (env) command line
  6. The application will automatically run by itself, but you can also access them by typing localhost:8501 in your web browser.