Skip to content

Commit 60b1ab1

Browse files
committed
Update docs with logo and simplify quickstart
Added Ethopy_analysis_logo.png and integrated it into the documentation. Simplified the quickstart guide by removing redundant DataFrame examples and focusing on database usage and CLI. Removed troubleshooting steps for DataFrame column errors. Updated mkdocs.yml to use the new logo and adjusted theme colors.
1 parent a8f9060 commit 60b1ab1

File tree

5 files changed

+14
-74
lines changed

5 files changed

+14
-74
lines changed

docs/Ethopy_analysis_logo.png

992 KB
Loading

docs/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Ethopy Analysis
22

3+
<img src="Ethopy_analysis_logo.png" alt="Ethopy Analysis" width="200"/>
4+
35
A comprehensive Python package for analyzing and visualizing behavioral data from Ethopy experiments.
46

57
## Overview

docs/quickstart.md

Lines changed: 2 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,7 @@ Get started with Ethopy Analysis in just a few steps.
44

55
## Basic Usage
66

7-
### 1. Simple Analysis with Your Data
8-
9-
```python
10-
import pandas as pd
11-
from ethopy_analysis.plots.animal import plot_animal_performance
12-
13-
# Your data (any pandas DataFrame with the right columns)
14-
performance_data = pd.DataFrame({
15-
'animal_id': [101, 101, 101],
16-
'session': [1, 2, 3],
17-
'correct_rate': [0.4, 0.6, 0.8],
18-
'total_trials': [50, 60, 55]
19-
})
20-
21-
# Create plot
22-
fig, ax = plot_animal_performance(performance_data, animal_id=101)
23-
```
24-
25-
### 2. Loading from Database
7+
### 1. Loading from Database
268

279
```python
2810
from ethopy_analysis.data.loaders import get_sessions
@@ -35,7 +17,7 @@ sessions = get_sessions(animal_id=123, min_trials=20)
3517
fig, ax = plot_session_performance(123, sessions['session'].values)
3618
```
3719

38-
### 3. Command Line Interface
20+
### 2. Command Line Interface
3921

4022
```bash
4123
# Analyze specific animal
@@ -126,31 +108,6 @@ plot_trial_time(animal_id, session, trials=[10, 11])
126108
- Update `animal_id` variables to match your data
127109
- Ensure database connection is configured (see [Configuration](configuration.md))
128110

129-
4. **Run the cells** to see analysis results
130-
131-
## Data Requirements
132-
133-
### Column Names
134-
Your DataFrame should have these columns:
135-
136-
- `animal_id`: Animal identifier
137-
- `session`: Session number/identifier
138-
- `correct_rate`: Success rate (0-1)
139-
- `trial_idx`: Trial number
140-
- `outcome`: Trial outcome ('correct', 'incorrect', 'timeout')
141-
142-
### Example Data Structure
143-
```python
144-
data = pd.DataFrame({
145-
'animal_id': [123, 123, 123],
146-
'session': [1, 2, 3],
147-
'correct_rate': [0.45, 0.52, 0.68],
148-
'total_trials': [50, 55, 60],
149-
'trial_idx': [1, 2, 3],
150-
'outcome': ['correct', 'incorrect', 'correct']
151-
})
152-
```
153-
154111
## Configuration
155112

156113
Before running database-dependent examples:

docs/troubleshooting.md

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -180,27 +180,6 @@ except ImportError as e:
180180
print(f"Missing dependency: {e}")
181181
```
182182

183-
### DataFrame Column Errors
184-
185-
**Problem**: KeyError for required columns
186-
187-
**Solutions**:
188-
```python
189-
# Check DataFrame structure
190-
print(df.columns.tolist())
191-
print(df.dtypes)
192-
193-
# Verify required columns exist
194-
required_cols = ['animal_id', 'session', 'correct_rate']
195-
missing_cols = [col for col in required_cols if col not in df.columns]
196-
print(f"Missing columns: {missing_cols}")
197-
198-
# Use data loading functions
199-
from ethopy_analysis.data.loaders import get_sessions
200-
sessions = get_sessions(animal_id=123)
201-
print(sessions.columns.tolist())
202-
```
203-
204183
### Plotting Errors
205184

206185
**Problem**: Matplotlib or plotting function errors

mkdocs.yml

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,20 @@ repo_url: https://github.com/ef-lab/ethopy_analysis
99
theme:
1010
name: material
1111
palette:
12-
- scheme: default
13-
primary: blue
14-
accent: light blue
15-
toggle:
16-
icon: material/brightness-7
17-
name: Switch to dark mode
1812
- scheme: slate
19-
primary: blue
20-
accent: light blue
13+
primary: teal
14+
accent: indigo blue
15+
toggle:
16+
icon: material/toggle-switch
17+
name: Switch to light mode
18+
- scheme: default
19+
primary: teal
20+
accent: indigo blue
2121
toggle:
2222
icon: material/brightness-4
2323
name: Switch to light mode
24+
logo: Ethopy_analysis_logo.png
25+
favicon: Ethopy_analysis_logo.png
2426
features:
2527
- navigation.tabs
2628
- navigation.sections

0 commit comments

Comments
 (0)