neuromorphopy 0.1.0

Lightweight python package for downloading neuron morphologies from the NeuroMorpho archives.

neuromorphopy

Lightweight python package for downloading neuron morphologies from the NeuroMorpho archives.

• Github repository: https://github.com/kpeez/neuromorphopy/

Features

• Simple and intuitive API for searching NeuroMorpho.org
• Efficient concurrent downloads of neuron morphologies
• Flexible query system with validation
• Automatic metadata handling
• Support for both synchronous and asynchronous operations

Requirements

• Python >= 3.11

Installation

The easiest way to install is using pip:

git clone https://github.com/kpeez/neuromorphopy.git
cd neuromorphopy
pip install -r requirements.txt
pip install -e .

Development

For development work, we recommend using uv for faster dependency resolution and better reproducibility:

# Install uv if you haven't already
curl -LsSf https://astral.sh/uv/install.sh | sh

# Clone and install
git clone https://github.com/kpeez/neuromorphopy.git
cd neuromorphopy
uv venv
uv sync

Usage

Create a query file (YAML or JSON) to specify what neurons you want:

# query.yml
filters:
  species: ["mouse"]
  brain_region: ["neocortex"]
  cell_type: ["pyramidal"]
sort: # sorting is optional
  field: "brain_region"
  ascending: true

Use the command line interface to search and download neurons:

neuromorpho search -q query.yml -o ./data

For advanced usage and programmatic API, see our documentation.