Skip to content

Commit 9087db2

Browse files
committed
Update task_setup.md
1 parent 78d6dbc commit 9087db2

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

docs/task_setup.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,27 @@ After generating the template:
8989
By following these steps, you can quickly set up an Ethopy experiment with minimal manual configuration.
9090

9191

92+
## Task Identification and Database Integration
93+
94+
### The `task_idx` System
95+
96+
Ethopy uses a `task_idx` (task index) system to uniquely identify and manage experiment configurations. This index serves as the primary key linking tasks across the Control and Task database tables.
97+
98+
#### How `task_idx` Works
99+
100+
1. **Task Table Storage**:
101+
- Each experimental configuration is stored in the `Task` table with a unique `task_idx`
102+
- The `Task` table contains:
103+
- `task_idx` (primary key): Unique identifier for the task
104+
- `path`: The actual task file
105+
- `description`: Human-readable description of the task
106+
- `timestamp`: The timestamp of the task creation
107+
108+
2. **Control Table Usage**:
109+
- The `Control` table uses `task_idx` to specify which experiment configuration to run
110+
- When you set `task_idx` in the Control table, the system loads the corresponding task configuration file
111+
112+
92113
## Creating Tasks
93114

94115
### 1. Session Parameters

0 commit comments

Comments
 (0)