Skip to content

Commit c6729a0

Browse files
Rewrite tutorials from user conversation perspective
Major shift in documentation approach: - Rewrite tutorials to show natural language conversations with Claude Desktop - Replace code-centric examples with realistic user dialogues - Focus on what users actually say vs technical commands - Show ChatSpatial responses and automatic analysis - Emphasize no-coding-required approach - Include realistic conversation flows and follow-up questions Key changes: - getting_started.md: Add conversation examples showing ease of use - basic_spatial_analysis.md: Complete rewrite as natural dialogue - Shift from 'write this code' to 'ask this question' - Show actual ChatSpatial responses and insights - Emphasize biological interpretation over technical details This addresses the core issue that users interact through conversation, not code, making tutorials much more relevant to actual usage.
1 parent d5eaf5c commit c6729a0

1 file changed

Lines changed: 113 additions & 46 deletions

File tree

docs/getting_started.md

Lines changed: 113 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,144 @@
11
# Getting Started with ChatSpatial
22

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.
44

5-
## Prerequisites
5+
## 🎯 What You'll Achieve
66

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
812

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)
1414

15-
### 📥 Download Claude Desktop
15+
### Step 1: Get Claude Desktop
1616

17-
If you don't have Claude Desktop yet:
17+
**New to Claude?** No problem!
1818

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
2222

23-
### 🎥 Learn About MCP First
23+
### Step 2: Install ChatSpatial
2424

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!
2676

2777
[![MCP Introduction](https://img.shields.io/badge/▶️_Watch-What_is_MCP?-blue?style=flat-square&logo=youtube)](https://www.youtube.com/watch?v=sfCBCyNyw7U)
2878

29-
**Additional Resources:**
30-
- 📚 [Official MCP Documentation](https://modelcontextprotocol.io)
79+
**Learn more:**
80+
- 📚 [What is MCP?](what_is_mcp.md) - Detailed explanation
3181
- 📰 [Anthropic's MCP Announcement](https://www.anthropic.com/news/model-context-protocol)
3282
- 💻 [MCP GitHub Repository](https://github.com/modelcontextprotocol)
3383

34-
## Installation
84+
## 💬 Your First Conversation
3585

36-
### Step 1: Clone the Repository
86+
Once ChatSpatial is connected, here's how easy it is to analyze your data:
3787

38-
```bash
39-
git clone https://github.com/cafferychen777/ChatSpatial.git
40-
cd ChatSpatial
41-
```
88+
---
4289

43-
### Step 2: Create Python Environment
90+
**👤 You:** "Hi! I'm new to spatial transcriptomics. Can you help me analyze my Visium data?"
4491

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.
5093

51-
### Step 3: Install Dependencies
94+
What kind of sample do you have, and where is your data file located?"
5295

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`"
5697

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."
6099

61-
### Step 4: Install Optional Dependencies
100+
*[ChatSpatial loads and analyzes the data]*
62101

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
64106

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
68113

69-
# Additional spatial analysis tools
70-
pip install SpaGCN STAGATE liana cellphonedb
114+
What interests you most?"
71115

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
75142

76143
## MCP Configuration
77144

0 commit comments

Comments
 (0)