Skip to main content

Provides common functions to download and process data from the mm3 data.

Project description

MICrONS-Combiner

License PyPi_Version

This project contains tools to work with the MICrONS Cortical MM3 dataset, providing a robust interface to interact with the nucleus data.

From version 0.3.0.0, the package will be renamed to microns-combiner in order to better reflect its usage. Latest version with name 'datacleaner' will be 0.2.

Key features

  • Simple interface to download and keep organized anatomical data via CAVEClient.
  • Allows to query the synapse table in chunks avoiding common pitfalls.
  • Easily process nucleus annotation tables.
  • Automatically segment the brain volume into cortical layers.
  • Tools for filtering and constructing connectome subsets.
  • Basic interface to add functional properties, including tuning curves and selectivity.

Install 📥

pip install microns-combiner

Using the package ⏩

  • Few lines of code to get a full table with neurons' brain area, layer, cell_type, proofreading information, and nucleus position:
#Import the lib
import microns_combiner as mic

#Target version and download folder
cleaner = mic.MicronsCombiner(datadir = "data", version=1300) 

#Download the data
cleaner.download_nucleus_data()

#Process the downloaded data and segment into layers
units, segments = cleaner.process_nucleus_data()
  • Filter easily! How can we get all neurons in V1, layers L2/3 and L4 with proofread axons?
units_filter = fl.filter_neurons(units, layer=['L2/3', 'L4'], proofread='ax_clean', brain_area='V1')
  • Robustly download synapses between a subset of pre and post-synaptic neurons in chunks.
preids  = units_filter['pt_root_id']
postids = units_filter['pt_root_id']
cleaner.download_synapse_data(preids, postids)

#Connection problems at chunk number 23? Just restart from there
cleanerdownload_synapse_data(preids, postids, start_index=23)

Check the docs and our tutorial notebook just below to get started!

Docs & Tutorials 📜

If it is the first time working with the MICrONS data, we recommend you read our basic tutorial (also available as a Python Notebook), as well as the official documentation of the MICrONS project.

If you want to contribute, please read our guidelines first. Feel free to open an issue if you find any problem.

You can find a full documentation of the API and functions in the docs.

Requirements

Dependencies

  • CaveCLIENT
  • Pandas
  • Numpy
  • Scipy
  • TQDM
  • Standard transform for coordinate change (MICrONS ecosystem)

Dev-dependencies

  • pdoc (to generate the docs)
  • ruff (to keep contributions in a consistent format)

Citation Policy 📚

If you use our code, please consider to cite the associated repository, as well as the IARPA MICrONS Minnie Project and the Microns Phase 3 NDA repository.

Our code serves as an interface for the MICrONS data. Please cite appropiate the literature for the data used following their Citation Policy. The papers may depend on the annotation tables used.

Our unit table is constructed by integrating information from the following papers:

  1. Functional connectomics spanning multiple areas of mouse visual cortex. The Microns Consortium. 2025
  2. Foundation model of neural activity predicts response to new stimulus types
  3. Perisomatic ultrastructure efficiently classifies cells in mouse cortex
  4. NEURD offers automated proofreading and feature extraction for connectomics
  5. CAVE: Connectome Annotation Versioning Engine

Acknowledgements

We acknowledge funding by the NextGenerationEU, in the framework of the FAIR—Future Artificial Intelligence Research project (FAIR PE00000013—CUP B43C22000800006).

Generating the docs

Go to the main folder of the repository, and run

pdoc -t docs-src/template src/microns_combiner/ -o docs/

The docs will be generated in the docs/ folder in HTML format, which can be checked with the browser.

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

microns_combiner-0.3.1.tar.gz (27.5 kB view details)

Uploaded Source

Built Distribution

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

microns_combiner-0.3.1-py3-none-any.whl (30.7 kB view details)

Uploaded Python 3

File details

Details for the file microns_combiner-0.3.1.tar.gz.

File metadata

  • Download URL: microns_combiner-0.3.1.tar.gz
  • Upload date:
  • Size: 27.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.10.20 Linux/6.5.0-17-generic

File hashes

Hashes for microns_combiner-0.3.1.tar.gz
Algorithm Hash digest
SHA256 da0da25b873f6719e459bb5984ff127938c7264aea08ee59e2b784ae0c01a7f4
MD5 727c663972cb718d2fd4eb8b757dcd86
BLAKE2b-256 b3d1cfac81a5776f31e092682be88fb5e47863fac9610ba1566f204a750ec265

See more details on using hashes here.

File details

Details for the file microns_combiner-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: microns_combiner-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 30.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.10.20 Linux/6.5.0-17-generic

File hashes

Hashes for microns_combiner-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 05b57db5edec5c03062558591db75d04eef0841ecd47e86cdc61717dc4f970be
MD5 c82c3bfd8ff80197e817ed835a7afcd5
BLAKE2b-256 f4609c5cdc361180ddc9a5121f58f019081ab5af5a62f18327da13d639bb26c0

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