Skip to content

Commit 2c1dae6

Browse files
committed
v0.3.3 - readme update
1 parent 4b4a8dc commit 2c1dae6

2 files changed

Lines changed: 8 additions & 2 deletions

File tree

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,16 @@
44

55
<div align="center"> <a href="https://neuropixels-channelmap-generator.pni.princeton.edu">>>> Online GUI <<<</a> </div><br>
66

7+
Purpose of this tool:
8+
- Convenient (fully browser-based) generation of "IMRO tables" (i.e. channelmaps + reference, + amplification gain for 1.0 probes) at your desk, without having to download, install SpikeGLX and plug-in a probe
9+
- Arbitrary selection of electrode geometries, within the boundaries of the electrode-ADC wiring constraints
10+
- Common presets available out of the box (reach out to suggest other common geometries!)
11+
- Simple pre-existing IMRO table loading (which is convenient to remember the probe geometry of a specific file, and allows you to use pre-existing files as a starting point to build a new channelmap)
12+
713

814
**Disclaimer**: this tool is in <u>beta</u> release and should be considered a work in progress, deployed early to gather feedback. The imro editor tools in SpikeGLX and Open Ephys work correctly. What we are providing here are tools to specify imro tables more easily and conveniently. However, it will take some time to debug all the issues in this beta. If you import one of our tables into SpikeGLX or Open Ephys, please be sure to double check that all the site selections, referencing, gains, and filter settings that get imported are what you intended.
915

10-
**⚠️ Important SpikeGLX Note**: When loading IMRO tables generated by this tool into SpikeGLX, the reference/gain editing options may appear greyed out. This is expected behavior for non-canonical IMRO tables. SpikeGLX greys out editing features for imported tables that don't match its canonical format (being whole/half-shank width boxes that enclose all AP channels with attributes for all channels). This allows SpikeGLX to use external tables "as is" without knowing how to modify them safely. If you need to make adjustments, use the [online gui](https://neuropixels-channelmap-generator.pni.princeton.edu) again: upload your .imro file as a starting point, then modify your .imro table before re-downlading it and re-importing into SpikeGLX.
16+
**Note of loading of custom IMRO tables to SpikeGLX**: When loading IMRO tables generated by this tool into SpikeGLX, the reference/gain editing options may appear greyed out. This is expected behavior for non-canonical IMRO tables. SpikeGLX greys out editing features for imported tables that don't match its canonical format (being whole/half-shank width boxes that enclose all AP channels with attributes for all channels). This allows SpikeGLX to use external tables "as is" without knowing how to modify them safely. If you need to make adjustments, use the [online gui](https://neuropixels-channelmap-generator.pni.princeton.edu) again: upload your .imro file as a starting point, then modify your .imro table before re-downlading it and re-importing into SpikeGLX.
1117

1218
## Installation
1319

channelmap_generator/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@
77

88
from .backend import *
99

10-
__version__ = "0.3.2"
10+
__version__ = "0.3.3"
1111
__author__ = "Maxime Beau"
1212
__email__ = "maxime@princeton.edu"

0 commit comments

Comments
 (0)