🌐 Language / 言語: English | 日本語
Before starting, you'll need temporary admin privileges to install required packages.
Request admin access by following this link: Mac Admin Privileges Request Guide
- Contact IT if you need access to this page
- The admin privilege gives you a 5-minute window to install packages
- You may need to refresh this privilege multiple times during installation
This installer automatically sets up the entire PFM Compass application with a single command. No technical knowledge required!
🍎 Mac/Linux Users:
# Download and run the installer curl -o install_pfm.sh https://raw.githubusercontent.com/MT-blamb/pfm_compass_streamlit/master/install_pfm.sh chmod +x install_pfm.sh ./install_pfm.sh🎮 Launch the application:
cd [installation-directory]/pfm_compass_streamlit ./launch_simple.sh # For demos ./launch_advanced.sh # For full featuresChoose your installation directory during setup - Desktop, current folder, or custom location!
A comprehensive retirement planning tool for the Japanese market, part of PFM's 2025 product roadmap. This MVP provides instant financial planning insights to drive MILIZE partnership revenue through structured guest data and booking conversions.
What we're building: AI & Data Science infrastructure for PFM Compass Life Planning Feature
Why: Supports PFM's main monetization strategy - earning revenue per financial planning session booked with MILIZE
Success metrics: Validated insights, deployed infrastructure, clean data via DynamoDB API, and PFM Team readiness
- FIRE Planning: Financial Independence, Retire Early calculations
- Traditional Planning: Standard pension-age retirement with Japanese pension integration
- Complete Japanese/English UI for the Japanese market
- Cultural and financial context appropriate for Japanese users
- Real-time lookup from 1.38M pre-computed retirement scenarios
- Interactive wealth timeline visualizations
- Comparative analysis against Japanese financial benchmarks
- What-if scenario modeling
- AI-powered recommendations based on user profile
- Status-based action items and next steps
- Integration pathway for MILIZE specialist bookings
- Python 3.8 or higher
- Git (for downloading the repository)
- Terminal/Command Prompt access
- Open Terminal/Command Prompt
- Navigate to your desired folder:
cd Desktop # or wherever you want to store the project
- Clone the repository:
git clone https://github.com/MT-blamb/pfm_compass_streamlit.git cd PFM_COMPASS_STREAMLIT
For stakeholders without development environments set up, follow this complete installation guide:
Before starting, you'll need temporary admin privileges to install required packages.
Request admin access by following this link: Mac Admin Privileges Request Guide
- Contact IT if you need access to this page
- The admin privilege gives you a 5-minute window to install packages
- You may need to refresh this privilege multiple times during installation
1. Install Xcode Command Line Tools (Required first)
xcode-select --install- A popup will appear → click Install
- This provides basic compilers and tools required on macOS
2. Install Homebrew (Package manager for Mac)
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"- Follow the prompts, enter your Mac password when asked
- Important: At the end, copy and paste the lines it gives you to add to
.zprofileor.zshrc - Verify installation:
brew --version3. Install Python (3.9 or 3.10 recommended)
brew install python@3.10- Confirm installation:
python3 --version4. Install Git (if not already installed)
brew install git- Confirm installation:
git --version5. Install Virtual Environment Tool
python3 -m pip install --upgrade pip
python3 -m pip install virtualenv6. Set Up Project Environment
cd ~/Desktop/PFM_COMPASS_STREAMLIT # Navigate to the downloaded repo
python3 -m venv venv # Create virtual environment
source venv/bin/activate # Activate it7. Install Python Dependencies
pip install -r requirements.txt8. Run the Application
- Simple bilingual app:
streamlit run app_bilingual.py- Advanced version:
cd bling
streamlit run app.pyIf brew command not found:
- Restart Terminal and try again
If streamlit command not found:
- Ensure virtual environment is activated:
source venv/bin/activate - Re-run:
pip install -r requirements.txt
If port already in use:
streamlit run app_bilingual.py --server.port 8502If you get permission errors:
- Request admin privileges again (5-minute window expired)
- Contact IT for additional support
Option A: Using pip (Recommended for most users)
# Install required packages
pip install -r requirements.txtOption B: Using conda (If you have Anaconda/Miniconda)
# Create new environment
conda create -n pfm-compass python=3.9
conda activate pfm-compass
pip install -r requirements.txtYou have two versions to choose from:
Best for: Quick demos, stakeholder presentations, basic functionality testing
streamlit run app_bilingual.pyFeatures:
- Clean, simple interface
- Japanese/English language toggle
- Core FIRE vs Traditional retirement analysis
- Essential metrics and visualizations
Best for: Complete testing, advanced analysis, full feature evaluation
cd bling
streamlit run app.pyFeatures:
- Enhanced UI with animations and modern styling
- Advanced scenario analysis and what-if modeling
- Detailed chart explanations and user guidance
- Comprehensive advice engine with actionable recommendations
- 90-day action plans
- MILIZE integration call-to-actions
After running either command, you'll see output like:
Local URL: http://localhost:8501
Network URL: http://192.168.1.100:8501
To use the app:
- Open your web browser
- Go to
http://localhost:8501 - The application will load automatically
To stop the app: Press Ctrl+C (Windows/Linux) or Cmd+C (Mac) in the terminal
- 1.38M retirement scenarios stored locally in
/data/pfm_compass_data/ - Partitioned by status color for optimized lookup
- No external S3 dependencies - all data included in repository
The system analyzes combinations of:
- Age groups: 20s, 30s (early/late), 40s (early/late), 50+
- Income levels: ¥2.5M to ¥15M annual income
- Savings buckets: ¥50K to ¥875K monthly savings
- Expense levels: ¥125K to ¥500K monthly retirement expenses
- Demographics: Gender, marital status, household size, housing status
- Streamlit: Interactive web application framework
- Plotly: Advanced data visualizations and charts
- Custom CSS: Enhanced UI with animations and modern styling
- Pandas: Data processing and scenario lookup
- NumPy: Mathematical calculations and projections
- Local Parquet files: High-performance data storage
├── app_bilingual.py # Simple version
├── bling/app.py # Advanced version
├── data/pfm_compass_data/ # All scenario data
├── requirements.txt # Python dependencies
└── README.md # This file
Use app_bilingual.py - cleaner interface, faster demos
Sample Test Profiles:
- Young Professional: Age 30-34, ¥7.5M income, ¥250K monthly savings
- Mid-Career: Age 35-39, ¥10.5M income, ¥400K monthly savings
- Pre-Retirement: Age 45-49, ¥15M income, ¥625K monthly savings
Use bling/app.py - full feature set, advanced analysis
Test the flow:
- Enter profile information in sidebar
- Click "Analyze"
- Review status and metrics
- Explore all 4 tabs: Timeline, Comparison, Scenarios, Advice
- Test language switching (English ↔ 日本語)
- Instant insights generation from user demographic input
- Structured data ready for DynamoDB API integration
- MILIZE booking motivation through gap analysis and recommendations
- FIRE feasibility assessment with specific timeline
- Traditional retirement readiness evaluation
- Personalized advice with actionable next steps
- Professional consultation pathway for deeper guidance
"Module not found" errors:
pip install --upgrade -r requirements.txtPort already in use:
streamlit run app_bilingual.py --server.port 8502Data loading issues:
- Ensure you're in the correct directory
- Check that
/data/pfm_compass_data/folder exists - Verify parquet files are present
Permission errors on Windows:
- Run Command Prompt as Administrator
- Or use PowerShell instead of Command Prompt
- Check terminal output for error messages
- Ensure Python version is 3.8+
- Verify all files downloaded correctly from repository
- App loads successfully on localhost
- Data lookup responds within 2 seconds
- All visualizations render correctly
- Language switching functions properly
- Insights generated match expected quality
- User flow supports MILIZE booking motivation
- Scenarios cover target demographic ranges
- Advice recommendations are actionable
- API Development: DynamoDB integration for real-time data exchange
- User Authentication: Integration with PFM user management
- Booking Flow: Direct MILIZE appointment scheduling
- Analytics: User behavior tracking and conversion metrics
- Cloud Infrastructure: AWS deployment configuration
- Performance Optimization: Caching and database optimization
- Monitoring: Application health and usage analytics
AI & Data Science Team - Core development and delivery
PFM Team - Integration and user experience
MILIZE Partnership - Business logic and monetization strategy
When you're finished using the PFM Compass demo, here's how to properly shut it down:
- Go to your Terminal/Command Prompt (where you ran the
streamlit runcommand) - Press the following keys:
- Mac/Linux:
Ctrl + C - Windows:
Ctrl + C
- Mac/Linux:
- You should see:
Stopping...or similar message - The app will shut down and return you to the command prompt
After stopping the app, deactivate your Python virtual environment:
deactivate- Simply close the browser tab with
http://localhost:8501 - Or close your entire browser if preferred
- Stops the local server running your app
- Frees up system resources (CPU, memory)
- Releases the port (8501) for other applications
- Returns Terminal to normal command prompt
If Ctrl + C doesn't work:
- Try pressing it multiple times
- Or close the Terminal/Command Prompt window entirely
If port remains busy after stopping:
# Find and kill the process using port 8501
lsof -ti:8501 | xargs kill -9If you need to restart the app:
- Follow the same startup commands from the installation guide
- Make sure you're in the correct directory and virtual environment
This MVP represents the data-side work owned by AI & Data Science Team, delivered in alignment with PFM Team requirements and MILIZE partnership objectives.