Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
229781a
chore: point pyright at the project .venv
tabedzki Jul 8, 2026
081d146
paper typo fix
m-beau Sep 18, 2026
3568638
(auto) Paper PDF Draft
m-beau Sep 18, 2026
5ad3a17
Merge pull request #40 from m-beau/tabedzki/chore/pyright-venv-config
m-beau Sep 18, 2026
b3cdb3c
fix: memory leak across atlases for each user
m-beau Sep 18, 2026
c1fdd06
fix: matplotlib memory leak + efficient atlas slice read to prevent f…
m-beau Sep 18, 2026
4b49107
minor version bump: 1.4.0
m-beau Sep 18, 2026
df36484
Merge pull request #59 from m-beau/dev
m-beau Sep 18, 2026
4b86fd4
PNI abbreviation
m-beau Sep 21, 2026
cb76a5b
(auto) Paper PDF Draft
m-beau Sep 21, 2026
a17606a
Paper fix
m-beau Sep 21, 2026
108eb35
make figure 1 fit in white space
m-beau Sep 21, 2026
52fafae
(auto) Paper PDF Draft
m-beau Sep 21, 2026
3dd5854
fixed paper figure 1 caption
m-beau Sep 21, 2026
eb850b2
make figure 1 fit in white space
m-beau Sep 23, 2026
412e217
(auto) Paper PDF Draft
m-beau Sep 23, 2026
c176ec9
fixed fig1 caption
m-beau Sep 23, 2026
1663ada
docs: add CITATION.cff referencing the JOSS paper and v1.4.0 release
tabedzki Sep 23, 2026
9354de8
docs: add CITATION.cff referencing the JOSS paper and v1.4.0 release-…
m-beau Sep 23, 2026
e1a36f9
fixed USA acronym in JOSS paper
m-beau Oct 7, 2026
cd1a07b
(auto) Paper PDF Draft
m-beau Oct 7, 2026
8a792fb
Fixed USA acronym in JOSS paper
m-beau Oct 7, 2026
7c7898d
fix: stop per-click gc.collect stalling the server; add stall/RSS wat…
tabedzki Oct 14, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
cff-version: 1.2.0
message: If you use this software, please cite the JOSS paper below.
title: 'PixelMap: A Browser-Based Tool for Wiring-Aware, Anatomy- and Activity-Guided Design of Neuropixels
Channelmaps'
type: software
authors:
- given-names: Maxime
family-names: Beau
orcid: https://orcid.org/0000-0002-8907-6612
- given-names: Julie M. J.
family-names: Fabre
orcid: https://orcid.org/0000-0003-0550-0410
- given-names: Christian
family-names: Tabedzki
orcid: https://orcid.org/0000-0001-8409-6094
- given-names: Jorge
family-names: Yanar
orcid: https://orcid.org/0000-0003-1416-3567
- given-names: Carlos D.
family-names: Brody
orcid: https://orcid.org/0000-0002-4201-561X
version: 1.4.0
date-released: '2026-09-19'
doi: 10.5281/zenodo.22850328
identifiers:
- type: doi
value: 10.5281/zenodo.22850327
description: Zenodo concept DOI (all versions)
- type: doi
value: 10.5281/zenodo.22850328
description: Zenodo archive of the v1.4.0 JOSS release
- type: doi
value: 10.21105/joss.11008
description: JOSS paper
repository-code: https://github.com/m-beau/pixelmap
url: https://pixelmap.pni.princeton.edu
license: GPL-3.0-only
preferred-citation:
type: article
title: 'PixelMap: A Browser-Based Tool for Wiring-Aware, Anatomy- and Activity-Guided Design of
Neuropixels Channelmaps'
authors:
- given-names: Maxime
family-names: Beau
orcid: https://orcid.org/0000-0002-8907-6612
- given-names: Julie M. J.
family-names: Fabre
orcid: https://orcid.org/0000-0003-0550-0410
- given-names: Christian
family-names: Tabedzki
orcid: https://orcid.org/0000-0001-8409-6094
- given-names: Jorge
family-names: Yanar
orcid: https://orcid.org/0000-0003-1416-3567
- given-names: Carlos D.
family-names: Brody
orcid: https://orcid.org/0000-0002-4201-561X
journal: Journal of Open Source Software
publisher:
name: Open Journals
year: 2026
start: 11008
doi: 10.21105/joss.11008
url: https://doi.org/10.21105/joss.11008
5 changes: 5 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@ services:
- ANALYTICS_COOKIE_MAX_AGE_DAYS=365
- ANALYTICS_COOKIE_SAMESITE=Lax
- ANALYTICS_COOKIE_SECURE=false
# Log a "[watchdog]" WARNING (with the blocked stack) when the event
# loop is stuck this long, and once when RSS crosses this many MB. See
# pixelmap/gui/watchdog.py. Set PIXELMAP_STALL_WARN_S=0 to disable.
- PIXELMAP_STALL_WARN_S=5
- PIXELMAP_RSS_WARN_MB=3000
volumes:
- ./output:/app/output
- brainglobe_cache:/root/.brainglobe
Expand Down
30 changes: 26 additions & 4 deletions paper/paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ authors:
orcid: 0000-0002-4201-561X
affiliation: "1, 2"
affiliations:
- name: Princeton Neuroscience Institute, Princeton University, USA
- name: Princeton Neuroscience Institute, Princeton University, United States of America
index: 1
- name: Howard Hughes Medical Institute, USA
- name: Howard Hughes Medical Institute, United States of America
index: 2
date: 29 May 2026
bibliography: paper.bib
Expand All @@ -52,7 +52,7 @@ Beyond satisfying hardware constraints, channelmaps must be tailored to the expe
1. **Being available on any machine installation-free** at [https://pixelmap.pni.princeton.edu](https://pixelmap.pni.princeton.edu).
2. **Visualising wiring constraints in real time**: When users select electrodes (red), the interface immediately shows which become unavailable (black) due to shared lines or ADCs, preventing invalid configurations.
3. **Supporting arbitrary electrode geometries** through 1) common preset geometries, 2) entering electrode ranges as text for reproducibility, 3) directly clicking or dragging on the probe visualisation, or 4) loading pre-existing `.imro` files. These four selection methods are compatible with one another and meant to be combined.
4. **Guiding channelmap design with anatomy and activity overlays**: Users can overlay anatomical region boundaries from any brain atlas available through BrainGlobe [@claudi2020] to plan recordings around specific brain regions of interest, and **simultaneously** a SpikeGLX activity survey heatmap to identify the most active channels and confirm anatomical predictions after probe implantation.
4. **Guiding channelmap design with anatomy and activity overlays**: Users can overlay anatomical region boundaries from any brain atlas available through BrainGlobe [@claudi2020] to plan recordings around specific brain regions of interest. They can also **simultaneously** overlay a SpikeGLX activity survey heatmap to identify the most active channels and confirm anatomical predictions after probe implantation.

| Probe Version | Physical Electrodes | Readout Channels |
|---------------|---------------------|------------------|
Expand Down Expand Up @@ -94,6 +94,28 @@ PixelMap's architecture is designed to easily support future hardware and atlase

**Contributor extensibility.** The codebase is written as comprehensively as possible with contributions in mind. New selection presets can be added to `backend.py`, new overlay types can follow the pattern established by the activity-survey and anatomy overlays, and the GUI layer can be extended or replaced without modifying the core constraint logic. This modular design, together with comprehensive tests and a [contributor guide](https://pixelmap-neuropixels.readthedocs.io/en/latest/development.html), is intended to make contribution straightforward. These design choices have already enabled two new contributors to add significant features in 2026, warranting authorship on this paper: the anatomical overlay (J.M.J.F.) and the activity survey overlay (J.Y.).

```{=latex}
\makeatletter
% JOSS's template forces every figure to [H] (float package), which wraps the
% figure in a single unbreakable box. Figure 1's caption is long, so that box
% does not fit in the space left on the page and LaTeX pushes the whole figure
% to the next page, leaving a large gap. Contribute the figure to the main
% vertical list instead, and typeset the caption as an ordinary paragraph, so
% the caption can break across pages. PDF only: the markdown is untouched, so
% the JATS/HTML outputs are unaffected.
\renewenvironment{figure}[1][]{%
\par\addvspace{\intextsep}%
\def\@captype{figure}%
}{%
\par\addvspace{\intextsep}%
}
\long\def\@makecaption#1#2{%
\vskip\abovecaptionskip\nobreak
\begingroup\captionfont\noindent{\captionlabelfont #1:} #2\par\endgroup
\vskip\belowcaptionskip}
\makeatother
```

![PixelMap's browser-based graphical user interface, shown here for a four-shank Neuropixels 2.0 probe.\
**Left:** *Probe and recording metadata* panel (these metadata are also written into `.imro` files), followed by three of the four methods of electrode selection: *Preset Selection* (preset geometries), *Textual Selection* (manual input of electrode ranges), and *Selection from IMRO file* (pre-loading an existing `.imro` file). These three methods can be mixed with each other and with the five interactive click-and-drag box tools, whose toolbar sits along the right edge of the central panel. Controls for the activity survey and anatomical overlays are further down this panel, below the cropped view.\
**Centre:** main panel featuring the probe's physical layout with one or four shanks that exhibit the 960 (Neuropixels 1.0) or 1,280 (Neuropixels 2.0, Quad Base) physical electrodes per shank to be selected from. Electrodes available for selection are light grey, selected electrodes turn red, and electrodes that become unavailable due to hardware wiring constraints turn black. In this example, 384 electrodes have been selected (matching the maximum simultaneous recording capacity of this probe), with a pattern distributed across multiple banks and shanks, illustrating that PixelMap allows selection of arbitrary channelmap geometries. The optional anatomical overlay, which guides channelmap design, is rendered beside the shanks as coloured depth bands with region labels.\
Expand All @@ -111,7 +133,7 @@ PixelMap addresses a practical bottleneck in Neuropixels experimental workflows.

PixelMap is released under an open-source licence (GPLv3), provides comprehensive documentation including a [contributor guide](https://pixelmap-neuropixels.readthedocs.io/en/latest/development.html), and is accessible via web application, Python package, Docker container, or programmatic API. It builds on the authors' track record using Neuropixels probes [@steinmetz2021; @bondy2024; @beau2025; @fabre2026basal] and developing Neuropixels software [@beau2021].

Adoption is evidenced by deployment on PNI's public server, 59 GitHub stars, and web traffic of roughly 400 unique visitors between March and May 2026 (~45/week; see the [analytics](https://github.com/m-beau/pixelmap/tree/main/analytics) folder of the repository). The package has been under active development for over ten months, with external contributors implementing new features (anatomical and activity overlays).
Adoption is evidenced by deployment on Princeton Neuroscience Institute's (PNI) public server, 59 GitHub stars, and web traffic of roughly 400 unique visitors between March and May 2026 (~45/week; see the [analytics](https://github.com/m-beau/pixelmap/tree/main/analytics) folder of the repository). The package has been under active development for over ten months, with external contributors implementing new features (anatomical and activity overlays).

# AI Usage Disclosure

Expand Down
Binary file modified paper/paper.pdf
Binary file not shown.
2 changes: 1 addition & 1 deletion pixelmap/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@

from .backend import *

__version__ = "1.3.1"
__version__ = "1.4.0"
__author__ = "Maxime Beau"
__email__ = "maxime@princeton.edu"
Loading
Loading