saoke-problem-solver / readme_2.md
heymenn's picture
Rename README.md to readme_2.md
e87cdce verified
# SAOKE Problem Solver
A modern web application that transforms technical problems into solutions using the SAOKE methodology (Subject-Action-Object-Knowledge-Effect).
## Overview
This application analyzes technical problems, extracts relevant effects, matches them with proven mechanisms from a patent database, and generates comprehensive solutions following the SAOKE framework.
## Features
### 🎨 Modern Web Interface
- Beautiful, responsive Streamlit-based UI
- Step-by-step guided workflow
- Progress tracking and visual indicators
- Real-time processing feedback
### πŸ”¬ Advanced Analysis
- AI-powered effect extraction using Google Gemini
- Semantic similarity matching with sentence transformers
- Patent-based mechanism retrieval
- Structured solution generation
### πŸš€ User-Friendly Workflow
1. **Problem Input** - Enter your technical challenge
2. **Effects Extraction** - AI extracts key effects (with regeneration)
3. **Mechanism Matching** - Maps effects to proven technologies
4. **Solution Generation** - Creates comprehensive solution (with regeneration)
## Installation
1. **Clone or download** the application files
2. **Install dependencies:**
```bash
pip install -r requirements.txt
```
3. **Ensure data file exists:** Place `SAOKE_technologies.xlsx` in the same directory
## Usage
### Web Application (Recommended)
```bash
python run_saoke_web_app.py
```
- Opens automatically in your browser at `http://localhost:8501`
- Modern, intuitive interface
- Real-time progress tracking
### Legacy Tkinter Application
```bash
python run_saoke_app_tkinter_backup.py
```
- Desktop GUI application
- Tabbed interface
- Basic functionality
## Requirements
- Python 3.8+
- Internet connection (for AI services)
- `SAOKE_technologies.xlsx` data file
- Required Python packages (see `requirements.txt`)
## Key Technologies
- **Streamlit** - Modern web interface
- **Google Gemini** - AI-powered text analysis
- **Sentence Transformers** - Semantic similarity matching
- **Pandas** - Data processing
- **NumPy** - Numerical computations
## File Structure
```
β”œβ”€β”€ saoke_web_app.py # Main web application
β”œβ”€β”€ run_saoke_web_app.py # Web app launcher
β”œβ”€β”€ saoke_app_tkinter_backup.py # Legacy Tkinter app
β”œβ”€β”€ run_saoke_app_tkinter_backup.py # Legacy launcher
β”œβ”€β”€ requirements.txt # Python dependencies
β”œβ”€β”€ SAOKE_technologies.xlsx # Patent mechanisms database
└── README.md # This file
```
## Example Workflow
1. **Enter Problem:** "I want to send a private message to my friend over the network"
2. **Effects Extracted:**
- Message Confidentiality Assurance
- Recipient-Exclusive Message Decryption
3. **Mechanisms Matched:**
- On-the-Fly Encryption/Decryption
- Asymmetric Encryption
4. **Solution Generated:**
- Structured implementation plan
- Functional and non-functional requirements
- Step-by-step SAOKE breakdown
## API Configuration
The application uses a hardcoded Gemini API key. For production use, consider:
- Environment variables for API keys
- User authentication
- Rate limiting
- Error handling improvements
## Support
For issues or questions:
1. Check that all requirements are installed
2. Verify `SAOKE_technologies.xlsx` exists
3. Ensure internet connectivity for AI services
4. Review console output for error messages