{
  "name": "napari-dmc-brainmap",
  "display_name": "dmc_brainmap",
  "visibility": "public",
  "icon": null,
  "categories": [],
  "schema_version": "0.3.0",
  "on_activate": null,
  "on_deactivate": null,
  "contributions": {
    "commands": [
      {
        "id": "napari-dmc-brainmap.ParamsWidget",
        "title": "Create params.json file",
        "python_name": "napari_dmc_brainmap.params:ParamsWidget",
        "short_title": null,
        "category": null,
        "icon": null,
        "enablement": null
      },
      {
        "id": "napari-dmc-brainmap.StitchingWidget",
        "title": "Stitch tif images",
        "python_name": "napari_dmc_brainmap.stitching:StitchingWidget",
        "short_title": null,
        "category": null,
        "icon": null,
        "enablement": null
      },
      {
        "id": "napari-dmc-brainmap.PaddingWidget",
        "title": "Padding of stitched images to match atlas resolution",
        "python_name": "napari_dmc_brainmap.padding:PaddingWidget",
        "short_title": null,
        "category": null,
        "icon": null,
        "enablement": null
      },
      {
        "id": "napari-dmc-brainmap.PreprocessingWidget",
        "title": "Make widget to perform preprocessing operations",
        "python_name": "napari_dmc_brainmap.preprocessing:PreprocessingWidget",
        "short_title": null,
        "category": null,
        "icon": null,
        "enablement": null
      },
      {
        "id": "napari-dmc-brainmap.RegistrationWidget",
        "title": "Make registration widget to start registration GUI",
        "python_name": "napari_dmc_brainmap.registration:RegistrationWidget",
        "short_title": null,
        "category": null,
        "icon": null,
        "enablement": null
      },
      {
        "id": "napari-dmc-brainmap.SegmentWidget",
        "title": "Make segmentation widget",
        "python_name": "napari_dmc_brainmap.segment:SegmentWidget",
        "short_title": null,
        "category": null,
        "icon": null,
        "enablement": null
      },
      {
        "id": "napari-dmc-brainmap.ResultsWidget",
        "title": "Make widget to create results file",
        "python_name": "napari_dmc_brainmap.results:ResultsWidget",
        "short_title": null,
        "category": null,
        "icon": null,
        "enablement": null
      },
      {
        "id": "napari-dmc-brainmap.VisualizationWidget",
        "title": "Make widget to visualize data",
        "python_name": "napari_dmc_brainmap.visualization:VisualizationWidget",
        "short_title": null,
        "category": null,
        "icon": null,
        "enablement": null
      }
    ],
    "readers": null,
    "writers": null,
    "widgets": [
      {
        "command": "napari-dmc-brainmap.ParamsWidget",
        "display_name": "Create params file (general info -- ALWAYS start with this!)",
        "autogenerate": false,
        "default_dock_area": "right",
        "tabify": false
      },
      {
        "command": "napari-dmc-brainmap.StitchingWidget",
        "display_name": "Stitch tif images",
        "autogenerate": false,
        "default_dock_area": "right",
        "tabify": false
      },
      {
        "command": "napari-dmc-brainmap.PaddingWidget",
        "display_name": "Padding of stitched images to match atlas resolution",
        "autogenerate": false,
        "default_dock_area": "right",
        "tabify": false
      },
      {
        "command": "napari-dmc-brainmap.PreprocessingWidget",
        "display_name": "Preprocessing",
        "autogenerate": false,
        "default_dock_area": "right",
        "tabify": false
      },
      {
        "command": "napari-dmc-brainmap.RegistrationWidget",
        "display_name": "Registration",
        "autogenerate": false,
        "default_dock_area": "right",
        "tabify": false
      },
      {
        "command": "napari-dmc-brainmap.SegmentWidget",
        "display_name": "Segmentation",
        "autogenerate": false,
        "default_dock_area": "right",
        "tabify": false
      },
      {
        "command": "napari-dmc-brainmap.ResultsWidget",
        "display_name": "Create results file",
        "autogenerate": false,
        "default_dock_area": "right",
        "tabify": false
      },
      {
        "command": "napari-dmc-brainmap.VisualizationWidget",
        "display_name": "Visualize data",
        "autogenerate": false,
        "default_dock_area": "right",
        "tabify": false
      }
    ],
    "sample_data": null,
    "themes": null,
    "menus": {},
    "submenus": null,
    "keybindings": null,
    "configurations": {}
  },
  "package_metadata": {
    "metadata_version": "2.4",
    "name": "napari-dmc-brainmap",
    "version": "0.2.2",
    "dynamic": [
      "license-file"
    ],
    "platform": null,
    "supported_platform": null,
    "summary": "DMC-BrainMap is an end-to-end tool for multi-feature brain mapping across species",
    "description": "\n# napari-dmc-brainmap\n*DMC-BrainMap is an end-to-end tool for multi-feature brain mapping across species.*  \nThis [napari](https://napari.org/stable/) plugin was generated with [Cookiecutter](https://github.com/cookiecutter/cookiecutter) using napari's [cookiecutter-napari-plugin](https://github.com/napari/cookiecutter-napari-plugin) template.\n\n[![Tests](https://github.com/hejDMC/napari-dmc-brainmap/actions/workflows/test_and_deploy.yml/badge.svg?branch=main)](https://github.com/hejDMC/napari-dmc-brainmap/actions/workflows/test_and_deploy.yml?query=branch%3Amain)\n[![codecov](https://codecov.io/gh/hejDMC/napari-dmc-brainmap/branch/main/graph/badge.svg)](https://app.codecov.io/gh/hejDMC/napari-dmc-brainmap)\n[![PyPI](https://img.shields.io/pypi/v/napari-dmc-brainmap.svg?color=green)](https://pypi.org/project/napari-dmc-brainmap)\n[![Python 3.11 | 3.12 | 3.13 | 3.14](https://img.shields.io/badge/python-3.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-blue)](https://www.python.org/downloads/)\n[![napari hub](https://img.shields.io/endpoint?url=https://api.napari-hub.org/shields/napari-dmc-brainmap)](https://napari-hub.org/plugins/napari-dmc-brainmap.html)\n[![Documentation](https://img.shields.io/badge/docs-latest-blue)](https://napari-dmc-brainmap.readthedocs.io/en/latest/)\n[![License: BSD-3-Clause](https://img.shields.io/badge/license-BSD--3--Clause-green)](https://github.com/hejDMC/napari-dmc-brainmap/blob/main/LICENSE.txt)\n\n\n## Quick start\nUser guides and tutorials are available in the\n[project wiki](https://github.com/hejDMC/napari-dmc-brainmap/wiki). The\ngenerated technical documentation is published on\n[Read the Docs](https://napari-dmc-brainmap.readthedocs.io/en/latest/).\n\n### Installation\n\nDMC-BrainMap is a plugin for [napari](https://napari.org/stable/). There are two recommended installation paths, depending on whether you want to use the released plugin or develop the code.\n\nDMC-BrainMap supports Python 3.11 through 3.14. On macOS, Apple Silicon is required; Intel Macs are not supported.\n\n#### Users\n\nFirst install napari by following the [napari installation guide](https://napari.org/dev/getting_started/installation.html). DMC-BrainMap requires napari 0.7 or newer, is tested with napari 0.8 and the current release (0.10), and installs into the same environment without replacing your napari version. Then install DMC-BrainMap from napari's graphical plugin manager:\n\n```text\nPlugins > Install/Uninstall Plugins...\n```\n\nSearch for `napari-dmc-brainmap`, then install it from the plugin manager. Napari handles the plugin installation graphically.\n\nYou can also install the released plugin from the command line, in the same environment as napari:\n\n```bash\npython -m pip install napari-dmc-brainmap\n```\n\nIf you installed napari with uv, use `uv pip install napari-dmc-brainmap` instead.\n\n##### Optional registration prediction\n\nPyTorch is optional and is not installed with the standard plugin. To use the\nregistration prediction feature in a pip or napari environment, install the\nCPU-only build separately:\n\n```bash\npython -m pip install \"torch>=2.12.0\" --index-url https://download.pytorch.org/whl/cpu\n```\n\nSee the\n[prediction-assisted registration guide](https://napari-dmc-brainmap.readthedocs.io/en/latest/registration_prediction.html)\nfor model download, setup, usage, and quality-control guidance.\n\nAfter installation, open DMC-BrainMap from the napari plugin menu:\n\n```text\nPlugins > dmc_brainmap\n```\n\n#### Developers\n\nFor troubleshooting and contributing to repo development, install the repository as an editable project with [uv](https://docs.astral.sh/uv/). In editable mode, code changes in this repository are picked up the next time napari is started with `uv run napari`.\n\nFirst install uv if needed, following the [uv installation guide](https://docs.astral.sh/uv/getting-started/installation/).\n\nClone the repository:\n\n```bash\ngit clone https://github.com/hejDMC/napari-dmc-brainmap.git\ncd napari-dmc-brainmap\n```\n\nSync the environment:\n\n```bash\nuv sync\n```\n\nThis creates the project environment with a compatible Python version, installs\nnapari and all required dependencies, and installs\n`napari-dmc-brainmap` from the local checkout. Optional prediction support is\ninstalled only when the `prediction` extra is selected as described below.\n\n##### Optional registration prediction\n\nEnable the `prediction` extra when synchronizing the development environment:\n\n```bash\nuv sync --extra prediction\n```\n\nTo include both prediction and test dependencies, use:\n\n```bash\nuv sync --extra prediction --group test\n```\n\n`uv sync --all-extras` also installs prediction support. A plain\n`uv sync` intentionally excludes optional extras and may remove a previously\ninstalled PyTorch package during exact synchronization. PyTorch remains\nrecorded in `uv.lock` so the selected extra stays reproducible.\n\nStart napari:\n\n```bash\nuv run napari\n```\n\nThen find DMC-BrainMap from the napari plugin menu:\n\n```text\nPlugins > dmc_brainmap\n```\n\n### Usage\n\n#### Coordinate convention\n\nDMC-BrainMap uses a left-positive mediolateral convention in result CSV files\nand user-facing analysis: `ML > 0` is anatomical left and `ML < 0` is\nanatomical right. In an unflipped coronal BrainGlobe atlas image, anatomical\nleft appears on image-right because the atlas `rl` index increases from right\nto left. See the\n[coordinate and hemisphere conventions](https://napari-dmc-brainmap.readthedocs.io/en/latest/coordinate_conventions.html)\nfor result-file compatibility and mirroring details.\n\nPlease 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:\n- DMC-BrainMap requires single-channel 16-bit .tif/.tiff images to work (in principle 8-bit also work)\n- DMC-BrainMap requires that your data is organized by animals in separate folders (you can pool data later down the lane)\n- 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.\n- 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**:\n```\nanimal_id-001\n│\n└───stitched\n│   │\n│   └───dapi\n│   |    │   animal_id-001_001.tiff\n│   |    │   animal_id-001_002.tiff\n|   │    |   animal_id-001_003.tiff\n│   |    │   animal_id-001_004.tiff\n│   |    │   ...\n│   │   \n│   └───green\n│       │   animal_id-001_001.tiff\n│       │   animal_id-001_002.tiff\n│       │   animal_id-001_003.tiff\n│       │   animal_id-001_004.tiff\n│       │   ...\n│   \nanimal_id-2\n│   ...\n```\n\n## Documentation\n\n- [Technical documentation](https://napari-dmc-brainmap.readthedocs.io/en/latest/)\n- [Prediction-assisted registration](https://napari-dmc-brainmap.readthedocs.io/en/latest/registration_prediction.html)\n- [User guides and tutorials](https://github.com/hejDMC/napari-dmc-brainmap/wiki)\n\n## Seeking help or contributing\n\nDMC-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. \n\n## License\n\nDistributed under the terms of the [BSD-3](https://github.com/teamdigitale/licenses/blob/master/BSD-3-Clause) license,\n\"napari-dmc-brainmap\" is free and open source software\n\n## Citing DMC-BrainMap\n\nIf you use DMC-BrainMap in your scientific work, please cite:\n```\nJung, 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\n```\n\nBibTeX:  \n``` bibtex\n@article{Jung2026a,\ntitle = {DMC-BrainMap is an open-source, end-to-end tool for multi-feature brain mapping in different species},\njournal = {Cell Reports Methods},\nvolume = {6},\nnumber = {2},\npages = {101302},\nyear = {2026},\nissn = {2667-2375},\ndoi = {https://doi.org/10.1016/j.crmeth.2026.101302},\nurl = {https://www.sciencedirect.com/science/article/pii/S2667237526000020},\nauthor = {Felix Jung and Xiao Cao and Loran Heymans and Marie Carlén}\n}\n```\n",
    "description_content_type": "text/markdown",
    "keywords": null,
    "home_page": null,
    "download_url": null,
    "author": null,
    "author_email": "Felix Jung <jung.neurosc@gmail.com>",
    "maintainer": null,
    "maintainer_email": null,
    "license": null,
    "classifier": [
      "Development Status :: 4 - Beta",
      "Framework :: napari",
      "Intended Audience :: Developers",
      "Operating System :: MacOS :: MacOS X",
      "Operating System :: Microsoft :: Windows",
      "Operating System :: POSIX :: Linux",
      "Programming Language :: Python",
      "Programming Language :: Python :: 3",
      "Programming Language :: Python :: 3 :: Only",
      "Programming Language :: Python :: 3.11",
      "Programming Language :: Python :: 3.12",
      "Programming Language :: Python :: 3.13",
      "Programming Language :: Python :: 3.14",
      "Topic :: Scientific/Engineering :: Image Processing"
    ],
    "requires_dist": [
      "brainglobe-atlasapi>=3.0.1",
      "distinctipy>=1.3.4",
      "imagecodecs>=2026.3.6",
      "joblib>=1.5.3",
      "magicgui>=0.10.2",
      "matplotlib>=3.10.9",
      "mergedeep>=1.3.4",
      "napari>=0.7.0",
      "natsort>=8.4.0",
      "numpy<3,>=2.4.6",
      "opencv-python>=4.13.0.92",
      "pandas<4,>=2.3.3",
      "platformdirs>=4.10.1",
      "probeinterface>=0.3.2",
      "pydantic<3,>=2.2",
      "qtpy>=2.4.3",
      "scikit-image>=0.26.0",
      "scikit-learn>=1.9.0",
      "scikit-spatial>=9.0.1",
      "seaborn>=0.13.2",
      "shapely>=2.1.2",
      "scipy>=1.17.1",
      "superqt>=0.8.2",
      "tifffile>=2026.3.3",
      "torch>=2.12.0; extra == \"prediction\""
    ],
    "requires_python": "<3.15,>=3.11",
    "requires_external": null,
    "project_url": null,
    "provides_extra": [
      "prediction"
    ],
    "provides_dist": null,
    "obsoletes_dist": null
  },
  "npe1_shim": false
}