How to install and demo - grishasen/proof_of_value GitHub Wiki
This guide provides step-by-step instructions on how to download and install Visual Studio Code (VS Code), install Python, and set up a Python virtual environment within VS Code. The last step will be to install the CDH Value Dashboard application from a Python package and start using it.
- Visit the official Visual Studio Code website: https://code.visualstudio.com/
- Click on the "Download for Windows" button.
- Locate the downloaded file (e.g.,
VSCodeUserSetup-x64-<version>.exe
) in your Downloads folder. - Double-click the installer to run it.
-
Accept License Agreement
- Read and accept the license agreement.
- Click "Next".
-
Select Destination Location
- Choose the installation folder or keep the default.
- Click "Next".
-
Select Start Menu Folder
- Choose the Start Menu folder or keep the default.
- Click "Next".
-
Select Additional Tasks
Optionally, select:- "Create a desktop icon"
- "Add to PATH (requires shell restart)" (Recommended)
- "Register Code as an editor for supported file types"
Click "Next".
-
Install
- Click "Install" to begin the installation.
-
Finish Installation
- Check "Launch Visual Studio Code" if you want to start it immediately.
- Click "Finish".
- Download Visual Studio Community Edition: https://visualstudio.microsoft.com/downloads/
- Launch installer – check Desktop Development with C++.
- Finish installation.
- Visit https://code.visualstudio.com/
- Click on the "Download for Mac" button.
- Locate the downloaded
VSCode-darwin-universal.zip
file. - Open the ZIP file to extract Visual Studio Code.app.
- Drag and drop Visual Studio Code.app into the Applications folder.
- Open Launchpad and click on Visual Studio Code.
- If prompted that the app is from an unidentified developer:
- Go to System Preferences > Security & Privacy > General tab
- Click "Open Anyway"
Using Terminal run:
xcode-select --install
- Visit https://www.python.org/downloads/windows/
- Click on "Download Python 3.11.x"
- Locate and run the installer (
python-3.x.x-amd64.exe
) - Check "Add Python 3.x to PATH"
- Click "Install Now"
- Confirm via User Account Control
- Click "Close"
- Verify installation:
python --version
- Open Terminal
- Run:
python3 --version
- Visit https://www.python.org/downloads/macos/
- Click "Download Python 3.11.x"
- Run installer (e.g.,
python-3.x.x-macosx10.9.pkg
) - Verify installation:
python3 --version
- Run git clone https://github.com/grishasen/proof_of_value.git
- Open VS Code.
- Go to File > Open Folder and select
proof_of_value
.
- Click Extensions on the left sidebar (Ctrl+Shift+X)
- Search and install Python extension.
-
Open Integrated Terminal: Terminal > New Terminal (Ctrl+Shift+`)
-
Ensure you're in the
proof_of_value
directory. -
Press Ctrl+Shift+P (or Cmd+Shift+P on macOS).
-
Type
"Python: Create Environment"
and select it. -
Choose the interpreter from
venv
.
Python environment setup is like brewing coffee — by the time it's done, you could have grown your own beans. Anyway – please go ahead, making coffee is essential part of install process.
-
Ensure virtual environment is active:
(venv)
prefix should be visible in the terminal. -
Install the package:
pip install cdhdashboard
Package installation takes so long, you can finish the coffee you made... and still have time to brew another one!
Alternatively, install from GitHub repository: https://github.com/grishasen/proof_of_value?tab=readme-ov-file#installation
cdhdashboard run -- --config ./config_demo.toml
or (if installed from GitHub)
streamlit run vd_app.py -- --config=<config_file_path.toml>
- Your browser should open automatically, if not, go to: http://localhost:8501/
- Visual Studio Code
- Python
- A virtual environment in VS Code
- CDH Value Dashboard application
This setup is a prerequisite for the bootcamp hands-on session.
- Use Demo config located at:
value_dashboard/config/config_demo.toml
- Unzip
.7z
file:data/demo_collected_ih_metrics_data.json.7z
- Go to Data Import Page
- Switch off toggle – Import raw data
- Upload file
demo_collected_ih_metrics_data.json
- Go to Dashboard Page, start browsing reports.
- Upload Product Holdings data and demo CLV analysis.