|
1 | 1 | # Getting Started with ChatSpatial |
2 | 2 |
|
3 | | -This comprehensive guide will help you install, configure, and run your first spatial transcriptomics analysis with ChatSpatial. |
| 3 | +Transform your spatial transcriptomics analysis from complex coding to natural conversation! This guide shows you how to set up ChatSpatial and start analyzing your data through simple questions in Claude Desktop. |
4 | 4 |
|
5 | | -## Prerequisites |
| 5 | +## 🎯 What You'll Achieve |
6 | 6 |
|
7 | | -Before installing ChatSpatial, ensure you have: |
| 7 | +By the end of this guide, you'll be able to: |
| 8 | +- 💬 **Ask questions** about your spatial data in plain English |
| 9 | +- 🧬 **Analyze tissue architecture** without writing code |
| 10 | +- 🎨 **Generate beautiful visualizations** automatically |
| 11 | +- 🔬 **Discover biological insights** through conversation |
8 | 12 |
|
9 | | -- **Python 3.10+** (recommended: 3.10 or 3.11) |
10 | | -- **Conda** or **Miniconda** for environment management |
11 | | -- **Git** for cloning the repository |
12 | | -- **8GB+ RAM** for typical spatial datasets |
13 | | -- **Claude Desktop** or another MCP-compatible client |
| 13 | +## 🚀 Quick Start (5 Minutes) |
14 | 14 |
|
15 | | -### 📥 Download Claude Desktop |
| 15 | +### Step 1: Get Claude Desktop |
16 | 16 |
|
17 | | -If you don't have Claude Desktop yet: |
| 17 | +**New to Claude?** No problem! |
18 | 18 |
|
19 | | -1. **Visit**: [claude.ai](https://claude.ai) |
20 | | -2. **Download**: Claude Desktop for your operating system |
21 | | -3. **Sign up**: Create an Anthropic account if needed |
| 19 | +1. 🌐 **Visit**: [claude.ai](https://claude.ai) |
| 20 | +2. 📱 **Download**: Claude Desktop for your computer |
| 21 | +3. 👤 **Sign up**: Create your free Anthropic account |
22 | 22 |
|
23 | | -### 🎥 Learn About MCP First |
| 23 | +### Step 2: Install ChatSpatial |
24 | 24 |
|
25 | | -New to Model Context Protocol? Watch this quick introduction: |
| 25 | +**Don't worry - this is easier than it looks!** |
| 26 | + |
| 27 | +Open your terminal/command prompt and run these commands: |
| 28 | + |
| 29 | +```bash |
| 30 | +# Create a new environment (like a clean workspace) |
| 31 | +conda create -n chatspatial python=3.11 |
| 32 | +conda activate chatspatial |
| 33 | + |
| 34 | +# Get ChatSpatial |
| 35 | +git clone https://github.com/cafferychen777/ChatSpatial.git |
| 36 | +cd ChatSpatial |
| 37 | +pip install -e . |
| 38 | +``` |
| 39 | + |
| 40 | +### Step 3: Connect to Claude Desktop |
| 41 | + |
| 42 | +**This is where the magic happens!** |
| 43 | + |
| 44 | +1. **Find your Python path**: |
| 45 | + ```bash |
| 46 | + conda activate chatspatial |
| 47 | + which python |
| 48 | + ``` |
| 49 | + Copy this path (something like `/Users/yourname/miniconda3/envs/chatspatial/bin/python`) |
| 50 | + |
| 51 | +2. **Configure Claude Desktop**: |
| 52 | + - **Mac**: Open `~/Library/Application Support/Claude/claude_desktop_config.json` |
| 53 | + - **Windows**: Open `%APPDATA%\Claude\claude_desktop_config.json` |
| 54 | + - **Linux**: Open `~/.config/Claude/claude_desktop_config.json` |
| 55 | + |
| 56 | +3. **Add this configuration** (replace the Python path with yours): |
| 57 | + ```json |
| 58 | + { |
| 59 | + "mcpServers": { |
| 60 | + "chatspatial": { |
| 61 | + "command": "/your/python/path/here", |
| 62 | + "args": ["-m", "chatspatial"], |
| 63 | + "env": {} |
| 64 | + } |
| 65 | + } |
| 66 | + } |
| 67 | + ``` |
| 68 | + |
| 69 | +4. **Restart Claude Desktop** |
| 70 | + |
| 71 | +### 🎉 You're Ready! |
| 72 | + |
| 73 | +Look for the 🔬 ChatSpatial tools in Claude Desktop. You should see spatial analysis tools available! |
| 74 | + |
| 75 | +## 🎥 New to MCP? Watch This First! |
26 | 76 |
|
27 | 77 | [](https://www.youtube.com/watch?v=sfCBCyNyw7U) |
28 | 78 |
|
29 | | -**Additional Resources:** |
30 | | -- 📚 [Official MCP Documentation](https://modelcontextprotocol.io) |
| 79 | +**Learn more:** |
| 80 | +- 📚 [What is MCP?](what_is_mcp.md) - Detailed explanation |
31 | 81 | - 📰 [Anthropic's MCP Announcement](https://www.anthropic.com/news/model-context-protocol) |
32 | 82 | - 💻 [MCP GitHub Repository](https://github.com/modelcontextprotocol) |
33 | 83 |
|
34 | | -## Installation |
| 84 | +## 💬 Your First Conversation |
35 | 85 |
|
36 | | -### Step 1: Clone the Repository |
| 86 | +Once ChatSpatial is connected, here's how easy it is to analyze your data: |
37 | 87 |
|
38 | | -```bash |
39 | | -git clone https://github.com/cafferychen777/ChatSpatial.git |
40 | | -cd ChatSpatial |
41 | | -``` |
| 88 | +--- |
42 | 89 |
|
43 | | -### Step 2: Create Python Environment |
| 90 | +**👤 You:** "Hi! I'm new to spatial transcriptomics. Can you help me analyze my Visium data?" |
44 | 91 |
|
45 | | -```bash |
46 | | -# Create a new conda environment |
47 | | -conda create -n chatspatial python=3.10 |
48 | | -conda activate chatspatial |
49 | | -``` |
| 92 | +**🤖 Claude:** "I'd love to help you explore your spatial transcriptomics data! ChatSpatial makes it easy - no coding required. Just tell me what you'd like to discover about your tissue. |
50 | 93 |
|
51 | | -### Step 3: Install Dependencies |
| 94 | +What kind of sample do you have, and where is your data file located?" |
52 | 95 |
|
53 | | -```bash |
54 | | -# Install ChatSpatial in development mode |
55 | | -pip install -e . |
| 96 | +**👤 You:** "I have a mouse brain sample. The file is at `/Users/myname/data/brain_sample.h5ad`" |
56 | 97 |
|
57 | | -# Verify installation |
58 | | -chatspatial --help |
59 | | -``` |
| 98 | +**🤖 Claude:** "Perfect! Let me load your mouse brain data and take a look at what we're working with." |
60 | 99 |
|
61 | | -### Step 4: Install Optional Dependencies |
| 100 | +*[ChatSpatial loads and analyzes the data]* |
62 | 101 |
|
63 | | -For full functionality, install additional packages: |
| 102 | +**🤖 Claude:** "Excellent! Your mouse brain sample looks great: |
| 103 | +- 2,845 spots across the tissue |
| 104 | +- 28,691 genes measured |
| 105 | +- High-quality spatial coordinates included |
64 | 106 |
|
65 | | -```bash |
66 | | -# R dependencies for scType |
67 | | -conda install -c conda-forge r-base r-essentials |
| 107 | +What would you like to explore? I can help you: |
| 108 | +- 🧠 Identify different brain regions |
| 109 | +- 🔬 Find cell types in each area |
| 110 | +- 📊 Discover spatially variable genes |
| 111 | +- 🎨 Create beautiful visualizations |
| 112 | +- 💬 Analyze cell-cell communication |
68 | 113 |
|
69 | | -# Additional spatial analysis tools |
70 | | -pip install SpaGCN STAGATE liana cellphonedb |
| 114 | +What interests you most?" |
71 | 115 |
|
72 | | -# GPU support (optional, for faster processing) |
73 | | -pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu118 |
74 | | -``` |
| 116 | +**👤 You:** "I'd love to see the different brain regions!" |
| 117 | + |
| 118 | +**🤖 Claude:** "Great choice! Let me identify the spatial domains in your brain tissue..." |
| 119 | + |
| 120 | +*[Analysis happens automatically]* |
| 121 | + |
| 122 | +**🤖 Claude:** "Amazing! I found 6 distinct brain regions: |
| 123 | +- Cortical layers (outer brain) |
| 124 | +- Hippocampus (memory center) |
| 125 | +- White matter (connecting fibers) |
| 126 | +- Ventricular zone (stem cells) |
| 127 | +- Corpus callosum (brain bridge) |
| 128 | +- Boundary regions |
| 129 | + |
| 130 | +Here's a beautiful spatial map showing each region in different colors! 🧠✨" |
| 131 | + |
| 132 | +--- |
| 133 | + |
| 134 | +### 🎯 See How Natural It Is? |
| 135 | + |
| 136 | +- ❌ **No complex commands** to remember |
| 137 | +- ❌ **No parameter tuning** required |
| 138 | +- ❌ **No coding experience** needed |
| 139 | +- ✅ **Just ask questions** in plain English! |
| 140 | +- ✅ **Get instant insights** about your tissue |
| 141 | +- ✅ **Beautiful visualizations** automatically generated |
75 | 142 |
|
76 | 143 | ## MCP Configuration |
77 | 144 |
|
|
0 commit comments