Skip to content

Commit 26662c2

Browse files
committed
fix md dot with bold
1 parent 3160791 commit 26662c2

File tree

1 file changed

+67
-65
lines changed

1 file changed

+67
-65
lines changed

docs/local_conf.md

Lines changed: 67 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -67,29 +67,28 @@ Here's the minimum configuration needed to get EthoPy running:
6767
**Settings explanation:**
6868

6969
- **`database.host`**: Database server IP address or hostname
70-
- **Default**: `"127.0.0.1"` (localhost - your computer)
71-
- **Examples**: `"192.168.1.100"`, `"lab-database.university.edu"`
70+
- **Default**: `"127.0.0.1"` (localhost - your computer)
71+
- **Examples**: `"192.168.1.100"`, `"lab-database.university.edu"`
7272

7373
- **`database.user`**: MySQL username for database connection
74-
- **Default**: `"root"`
74+
- **Default**: `"root"`
7575

7676
- **`database.password`**: MySQL password for the specified user
77-
- **Default**: `""` (empty string)
78-
- **Important**: Must match your MySQL user's password
77+
- **Default**: `""` (empty string)
7978

8079
- **`database.port`**: MySQL server port number
81-
- **Default**: `3306` (standard MySQL port)
82-
- **Note**: Only change if your MySQL uses a different port
80+
- **Default**: `3306` (standard MySQL port)
81+
- **Note**: Only change if your MySQL uses a different port
8382

8483
- **`database.reconnect`**: Automatically reconnect if connection is lost
85-
- **Default**: `true`
84+
- **Default**: `true`
8685

8786
- **`database.use_tls`**: Use encrypted TLS connection to database, more details [here](https://docs.datajoint.com/core/datajoint-python/latest/client/settings/#tls-configuration)
88-
- **Default**: `false`
87+
- **Default**: `false`
8988

9089
- **`datajoint.loglevel`**: DataJoint library logging verbosity
91-
- **Default**: `"WARNING"`
92-
- **Options**: `"DEBUG"`, `"INFO"`, `"WARNING"`, `"ERROR"`, `"CRITICAL"`
90+
- **Default**: `"WARNING"`
91+
- **Options**: `"DEBUG"`, `"INFO"`, `"WARNING"`, `"ERROR"`, `"CRITICAL"`
9392

9493
### 2. File Paths (Required)
9594

@@ -103,14 +102,14 @@ Here's the minimum configuration needed to get EthoPy running:
103102
**Settings explanation:**
104103

105104
- **`source_path`**: Local directory where experimental data files are saved
106-
- **Default**: `"~/EthoPy_Files"` (EthoPy_Files folder in your home directory)
107-
- **Purpose**: All recorded data (videos, sensor data, etc.) is stored here during experiments
108-
- **Examples**: `"/Users/yourname/experiment_data"`, `"/home/pi/data"`
105+
- **Default**: `"~/EthoPy_Files"` (EthoPy_Files folder in your home directory)
106+
- **Purpose**: All recorded data (videos, sensor data, etc.) is stored here during experiments
107+
- **Examples**: `"/Users/yourname/experiment_data"`, `"/home/pi/data"`
109108

110109
- **`target_path`**: Directory where backup copies of data should be moved after experiments
111-
- **Default**: `"/"` (root directory - usually needs to be changed)
112-
- **Purpose**: Automatic backup/archival location for completed experiments
113-
- **Examples**: `"/mnt/lab_storage"`
110+
- **Default**: `"/"` (root directory - usually needs to be changed)
111+
- **Purpose**: Automatic backup/archival location for completed experiments
112+
- **Examples**: `"/mnt/lab_storage"`
114113

115114
**Important**: Always use full paths starting from your drive root.
116115

@@ -131,25 +130,25 @@ Here's the minimum configuration needed to get EthoPy running:
131130
**Settings explanation:**
132131

133132
- **`level`**: Minimum log level to record
134-
- **Default**: `"INFO"`
135-
- **Options**: `"DEBUG"` (most verbose), `"INFO"`, `"WARNING"`, `"ERROR"`, `"CRITICAL"` (least verbose)
136-
- **Purpose**: Controls how much detail is logged
133+
- **Default**: `"INFO"`
134+
- **Options**: `"DEBUG"` (most verbose), `"INFO"`, `"WARNING"`, `"ERROR"`, `"CRITICAL"` (least verbose)
135+
- **Purpose**: Controls how much detail is logged
137136

138137
- **`directory`**: Directory where log files are stored
139-
- **Default**: `"~/.ethopy/"` (hidden .ethopy folder in your home directory)
140-
- **Examples**: `"/var/log/ethopy"`, `"/Users/yourname/logs"`
138+
- **Default**: `"~/.ethopy/"` (hidden .ethopy folder in your home directory)
139+
- **Examples**: `"/var/log/ethopy"`, `"/Users/yourname/logs"`
141140

142141
- **`filename`**: Name of the main log file
143-
- **Default**: `"ethopy.log"`
144-
- **Note**: Backup files will be named `ethopy.log.1`, `ethopy.log.2`, etc.
142+
- **Default**: `"ethopy.log"`
143+
- **Note**: Backup files will be named `ethopy.log.1`, `ethopy.log.2`, etc.
145144

146145
- **`max_size`**: Maximum size of log file before rotation (in bytes)
147-
- **Default**: `31457280` (30 MB)
148-
- **Purpose**: Prevents log files from growing too large
146+
- **Default**: `31457280` (30 MB)
147+
- **Purpose**: Prevents log files from growing too large
149148

150149
- **`backup_count`**: Number of old log files to keep
151-
- **Default**: `5`
152-
- **Purpose**: Maintains history while preventing unlimited disk usage
150+
- **Default**: `5`
151+
- **Purpose**: Maintains history while preventing unlimited disk usage
153152

154153
### 4. Hardware Setup (Optional - Raspberry Pi only)
155154

@@ -168,24 +167,25 @@ If you're using physical hardware (valves, sensors, LEDs), specify GPIO pin conn
168167
**Settings explanation:**
169168

170169
- **`channels`**: Maps hardware types to GPIO pin assignments
171-
- **Default**: Not set (no hardware channels configured)
172-
- **Purpose**: Tells EthoPy which GPIO pins control which hardware devices
170+
- **Default**: Not set (no hardware channels configured)
171+
- **Purpose**: Tells EthoPy which GPIO pins control which hardware devices
173172

174173
**Hardware types:**
175174

176175
- **`Liquid`**: Water delivery pumps/valves for reward delivery
177-
- **Format**: `{"port_number": gpio_pin_number}`
178-
- **Example**: `{"1": 22, "2": 23}` means port 1 uses GPIO pin 22, port 2 uses GPIO pin 23
176+
- **Format**: `{"port_number": gpio_pin_number}`
177+
- **Example**: `{"1": 22, "2": 23}` means port 1 uses GPIO pin 22, port 2 uses GPIO pin 23
179178

180179
- **`Lick`**: Lick detection sensors for behavioral monitoring
181-
- **Format**: `{"sensor_number": gpio_pin_number}`
182-
- **Example**: `{"1": 17, "2": 27}` means lick sensor 1 on GPIO pin 17, sensor 2 on GPIO pin 27
180+
- **Format**: `{"sensor_number": gpio_pin_number}`
181+
- **Example**: `{"1": 17, "2": 27}` means lick sensor 1 on GPIO pin 17, sensor 2 on GPIO pin 27
183182

184183
- **`Odor`**: Odor delivery valves for olfactory experiments
185-
- **Format**: `{"valve_number": gpio_pin_number}`
186-
- **Example**: `{"1": 24, "2": 25}` means valve 1 on GPIO pin 24, valve 2 on GPIO pin 25
184+
- **Format**: `{"valve_number": gpio_pin_number}`
185+
- **Example**: `{"1": 24, "2": 25}` means valve 1 on GPIO pin 24, valve 2 on GPIO pin 25
187186

188187
**Important notes:**
188+
189189
- Each GPIO pin number can only be used once across all hardware types
190190

191191
### 5. Custom Schema Names (Optional)
@@ -207,29 +207,29 @@ If your database uses custom schema names:
207207
**Settings explanation:**
208208

209209
- **`SCHEMATA`**: Maps EthoPy data types to your custom database schema names
210-
- **Purpose**: Allows EthoPy to work with existing databases that use different naming conventions
210+
- **Purpose**: Allows EthoPy to work with existing databases that use different naming conventions
211211

212212
**Schema types and defaults:**
213213

214214
- **`experiment`**: Main experimental session data
215-
- **Default**: `"lab_experiments"`
216-
- **Contains**: Session info, trial data, animal information
215+
- **Default**: `"lab_experiments"`
216+
- **Contains**: Session info, trial data, animal information
217217

218218
- **`behavior`**: Behavioral measurement data
219-
- **Default**: `"lab_behavior"`
220-
- **Contains**: Lick detection, movement tracking, response data
219+
- **Default**: `"lab_behavior"`
220+
- **Contains**: Lick detection, movement tracking, response data
221221

222222
- **`stimulus`**: Stimulus presentation information
223-
- **Default**: `"lab_stimuli"`
224-
- **Contains**: Visual/auditory stimuli parameters, timing
223+
- **Default**: `"lab_stimuli"`
224+
- **Contains**: Visual/auditory stimuli parameters, timing
225225

226226
- **`interface`**: Hardware interface configurations
227-
- **Default**: `"lab_interface"`
228-
- **Contains**: Hardware setup parameters, calibration data
227+
- **Default**: `"lab_interface"`
228+
- **Contains**: Hardware setup parameters, calibration data
229229

230230
- **`recording`**: Data recording metadata
231-
- **Default**: `"lab_recordings"`
232-
- **Contains**: File paths, recording parameters, data format info
231+
- **Default**: `"lab_recordings"`
232+
- **Contains**: File paths, recording parameters, data format info
233233

234234
**Note**: Most users can skip this section - EthoPy will use the default schema names.
235235

@@ -244,9 +244,9 @@ If your database uses custom schema names:
244244
**Settings explanation:**
245245

246246
- **`plugin_path`**: Directory where EthoPy plugins are stored
247-
- **Default**: `"~/.ethopy/ethopy_plugins"` (plugins folder in your .ethopy directory)
248-
- **Purpose**: Location for custom EthoPy extensions and plugins
249-
- **Examples**: `"/Users/yourname/my_plugins"`, `"/opt/ethopy_plugins"`
247+
- **Default**: `"~/.ethopy/ethopy_plugins"` (plugins folder in your .ethopy directory)
248+
- **Purpose**: Location for custom EthoPy extensions and plugins
249+
- **Examples**: `"/Users/yourname/my_plugins"`, `"/opt/ethopy_plugins"`
250250

251251
**Note**: Only needed if you're using custom plugins or want to store them in a different location.
252252

@@ -310,11 +310,11 @@ If your database uses custom schema names:
310310
1. **Check your password** - Verify the password matches your MySQL password
311311

312312
2. **Advanced troubleshooting**: For remote databases or lab setups, contact your system administrator or IT support to verify database server status, network connectivity, and firewall settings. **Check if MySQL is running**
313-
- If `database.host` is `127.0.0.1` or `localhost`: Run `mysql -u root -p` on the same machine as EthoPy
314-
- If `database.host` is a remote IP (like `192.168.1.100`): Run the command on that remote database server
315-
- The command should ask for your password and connect successfully
316-
- If you get "command not found", MySQL client is not installed
317-
- If you get "connection refused", MySQL server is not running
313+
- If `database.host` is `127.0.0.1` or `localhost`: Run `mysql -u root -p` on the same machine as EthoPy
314+
- If `database.host` is a remote IP (like `192.168.1.100`): Run the command on that remote database server
315+
- The command should ask for your password and connect successfully
316+
- If you get "command not found", MySQL client is not installed
317+
- If you get "connection refused", MySQL server is not running
318318

319319
3. **Check the database address** - For `127.0.0.1`, MySQL must be on your computer
320320

@@ -364,17 +364,19 @@ If your database uses custom schema names:
364364
## Local vs Database Settings
365365

366366
**Store in local_conf.json:**
367-
- Database connection details
368-
- File paths specific to this machine
369-
- Hardware GPIO pin assignments
370-
- Logging preferences
371-
- Machine-specific settings
367+
368+
- Database connection details
369+
- File paths specific to this machine
370+
- Hardware GPIO pin assignments
371+
- Logging preferences
372+
- Machine-specific settings
372373

373374
**Store in database:**
374-
- Experimental parameters
375-
- Trial configurations
376-
- Animal information
377-
- Session data
378-
- Results and measurements
375+
376+
- Experimental parameters
377+
- Trial configurations
378+
- Animal information
379+
- Session data
380+
- Results and measurements
379381

380382
This separation keeps your experiments portable while maintaining machine-specific configurations.

0 commit comments

Comments
 (0)