Skip to content

Commit d348270

Browse files
author
Jacob Pennington
committed
Updated tutorials to mention using multiple filenames
1 parent 9516284 commit d348270

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

docs/gui_guide.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This page explains how to use the basic functions of Kilosort4 GUI, in order of
77

88
Select data
99
-----------
10-
Start by selecting a binary data file (.bin, .bat, .dat, or .raw) to load, by clicking on the "Select Binary File" button near the top-left of the GUI. This will open a file dialog that will populate the neighboring text field after a file is selected. You can also paste a filepath directly into the text field.
10+
Start by selecting a binary data file (.bin, .bat, .dat, or .raw) to load by clicking on the "Select Binary File" button near the top-left of the GUI. This will open a file dialog that will populate the neighboring text field after a file is selected. You can also paste a filepath directly into the text field. If you select/enter multiple data files, they will be treated as if concatenated in time in the order provided.
1111

1212
.. image:: https://www.kilosort.org/static/images/gui_select_binary.png
1313
:width: 600

docs/tutorials/basic_example.ipynb

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@
8686
"# NOTE: 'n_chan_bin' is a required setting, and should reflect the total number\n",
8787
"# of channels in the binary file. For information on other available\n",
8888
"# settings, see `kilosort.run_kilosort.default_settings`.\n",
89-
"settings = {'data_dir': SAVE_PATH.parent, 'n_chan_bin': 385}\n",
89+
"settings = {'filename': SAVE_PATH, 'n_chan_bin': 385}\n",
9090
"\n",
9191
"ops, st, clu, tF, Wall, similar_templates, is_ref, est_contam_rate, kept_spikes = \\\n",
9292
" run_kilosort(\n",
@@ -95,6 +95,13 @@
9595
" )"
9696
]
9797
},
98+
{
99+
"cell_type": "markdown",
100+
"metadata": {},
101+
"source": [
102+
"`run_kilosort` will also accept a list of paths for the `filename` setting, in which case the files will be concatenated in time in the order provided. The built-in `glob` library provides methods for easily collecting lists of file names, but make sure you check the ordering."
103+
]
104+
},
98105
{
99106
"cell_type": "markdown",
100107
"metadata": {},

0 commit comments

Comments
 (0)