Skip to main content

DMC-BrainMap is an end-to-end tool for multi-feature brain mapping across species

Project description

napari-dmc-brainmap

DMC-BrainMap is an end-to-end tool for multi-feature brain mapping across species.
This napari plugin was generated with Cookiecutter using napari's cookiecutter-napari-plugin template.

License BSD-3 PyPI Python Version napari hub

Quick start

A detailed guide and tutorial can be found on the Wiki pages of this repo.

Installation

DMC-BrainMap is a plugin for napari. Hence, you first need to install napari and subsequently the DMC-BrainMap plugin via the plugin manager. To install napari, we recommend to install napari into a clean virtual environment using conda or venv. Please refer to the napari installation guide for more information and for information on installing napari as a bundled app.

Step 1: Setup the virtual environment (Python 3.10)

conda create -y -n napari-env -c conda-forge python=3.10
conda activate napari-env

Step 2: Install napari

python -m pip install "napari[all]"

Step 3: Install napari-dmc-brainmap

You can install napari-dmc-brainmap via the napari plugin manager or via pip:

pip install napari-dmc-brainmap

Usage

Please refer to the Wiki pages for detailed instructions and a short tutorial on how to use DMC-BrainMap. When working with DMC-BrainMap on your own data, please keep the following points in mind:

  • DMC-BrainMap requires single-channel 16-bit .tif/.tiff images to work (in principle 8-bit also work)
  • DMC-BrainMap requires that your data is organized by animals in separate folders (you can pool data later down the lane)
  • DMC-BrainMap uses 5 channel labels (dapi, green, n3, cy3, cy5) corresponding to blue, green, orange, red and far red channels. However, these are only labels, you can assign them as you please. Hence, you can use DMC-BrainMap also for non-fluorescence data given you converted your images to single-channel 16-bit .tif/.tiff images. Please contact us if you need to use more than 5 channels.
  • It is essential that you structure your data in the following way (hierarchical organization, same name for images in different channels, channel labels are selected by you), otherwise DMC-BrainMap won't work:
animal_id-001
│
└───stitched
│   │
│   └───dapi
│   |    │   animal_id-001_001.tiff
│   |    │   animal_id-001_002.tiff
|   │    |   animal_id-001_003.tiff
│   |    │   animal_id-001_004.tiff
│   |    │   ...
│   │   
│   └───green
│       │   animal_id-001_001.tiff
│       │   animal_id-001_002.tiff
│       │   animal_id-001_003.tiff
│       │   animal_id-001_004.tiff
│       │   ...
│   
animal_id-2
│   ...

Documentation

Documentation on DMC-BrainMap's source code can be found on the project's Read the Docs page.

Seeking help or contributing

DMC-BrainMap is an open-source project, and we welcome contributions of all kinds. If you have any questions, feedback, or suggestions, please feel free to open an issue on this repository.

License

Distributed under the terms of the BSD-3 license, "napari-dmc-brainmap" is free and open source software

Citing DMC-BrainMap

If you use DMC-BrainMap in your scientific work, please cite:

Jung, F., Cao, X., Heymans, L., Carlén, M. (2026) "DMC-BrainMap is an open-source, end-to-end tool for multi-feature brain mapping across species", Cell Reports Methods, https://doi.org/10.1016/j.crmeth.2026.101302

BibTeX:

@article{Jung2026a,
title = {DMC-BrainMap is an open-source, end-to-end tool for multi-feature brain mapping in different species},
journal = {Cell Reports Methods},
volume = {6},
number = {2},
pages = {101302},
year = {2026},
issn = {2667-2375},
doi = {https://doi.org/10.1016/j.crmeth.2026.101302},
url = {https://www.sciencedirect.com/science/article/pii/S2667237526000020},
author = {Felix Jung and Xiao Cao and Loran Heymans and Marie Carlén}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

napari_dmc_brainmap-0.1.7b15.tar.gz (367.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

napari_dmc_brainmap-0.1.7b15-py310-none-any.whl (395.8 kB view details)

Uploaded Python 3.10

File details

Details for the file napari_dmc_brainmap-0.1.7b15.tar.gz.

File metadata

  • Download URL: napari_dmc_brainmap-0.1.7b15.tar.gz
  • Upload date:
  • Size: 367.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.20

File hashes

Hashes for napari_dmc_brainmap-0.1.7b15.tar.gz
Algorithm Hash digest
SHA256 d1e63253d2e9bc78ca7e1c5eedfc5085716e28afb33d27c1bab3722b51a4e94a
MD5 0b9f4b71b1e12e118934a30eb6ab4cdf
BLAKE2b-256 9757a6968f14f1212c7e88d3b046933cffe72a1217e6e6b2382fc45c50b293b2

See more details on using hashes here.

File details

Details for the file napari_dmc_brainmap-0.1.7b15-py310-none-any.whl.

File metadata

File hashes

Hashes for napari_dmc_brainmap-0.1.7b15-py310-none-any.whl
Algorithm Hash digest
SHA256 3319af47ac8886758117e36b243b24cd2e5b70a708276ca41e0badad26478b5a
MD5 a3cf684c7d04bf4a3b83bc9fc31fd334
BLAKE2b-256 5f790e39a1264f2404ff2bbdfea3f3efa3c79fd22c8bea1c3a8ac74d90390ddd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page