colorspaces / QUICKSTART.md
amithjkamath's picture
Update colorspace demo
719e71f
|
Raw
History Blame Contribute Delete
2 kB
# πŸš€ Quick Start Guide
## Running Locally
### Option 1: Using Make (Recommended)
```bash
# Set up everything
make setup
# Run the app
make run
```
### Option 2: Manual Setup
```bash
# Create virtual environment
python3 -m venv venv
# Activate it
source venv/bin/activate # On macOS/Linux
# or
venv\Scripts\activate # On Windows
# Install dependencies
pip install -r requirements.txt
# Run the app
streamlit run app.py
```
## πŸ“– What to Explore
### 1. RGB Tab
Start here! Learn about the additive color model and see how red, green, and blue combine.
### 2. HSV/HSI Tab
Discover how hue, saturation, and value/intensity provide a more intuitive way to work with colors.
### 3. CIE-LAB Tab
Explore perceptually uniform colorspace and calculate color differences.
### 4. CMYK Tab
Understand the subtractive color model used in printing.
### 5. YCbCr Tab
Learn how chroma subsampling reduces file sizes in JPEG and video.
### 6. Gamma & White Balance Tab
Experiment with gamma correction and color temperature adjustment.
### 7. Color Blindness Tab
Simulate different types of color vision deficiency and test your designs for accessibility.
## πŸ’‘ Tips
- **Upload your own images** using the file uploader in each tab
- **Adjust sliders** to see real-time changes
- **Compare before/after** to understand transformations
- **Read the insights** at the bottom of each tab for key concepts
## πŸŽ“ For Students
Work through the tabs in order to build understanding from basic (RGB) to advanced (perceptual spaces and corrections).
## πŸ‘¨β€πŸ« For Instructors
Use this tool to:
- Demonstrate concepts during lectures
- Assign hands-on exercises
- Show real-world applications
- Test design accessibility
## πŸ› Issues?
If you encounter any problems:
1. Make sure all dependencies are installed: `make setup`
2. Check Python version (3.8+ required)
3. Try with the sample images first before uploading custom images
4. Open an issue on GitHub
---
Happy exploring! 🎨