Skip to main content

A simple tool for computing and visualising neuron receptive fields.

Project description

Receptual

PyPI version Read the Docs Ruff CI pre-commit codecov License: MIT

Receptual is a lightweight, interactive tool for computing and visualizing neuron receptive fields and linear decoders.

Overview

Linear encoding and decoding methods are essential tools for:

  • Systems neuroscience
  • Computational neuroscience
  • Deep learning interpretability

However, these methods often produce high-dimensional arrays, which are difficult to analyze and interpret. Additionally, despite the ubiquity of linear methods, implementing them can be challenging.

Receptual helps by providing standardized algorithm implementations for linear encoding and decoding methods. We also provide a visualization tool to help you explore the high-dimensional arrays that often result from these methods.

Key Features

  • Interactive 3D Visualization
    OpenGL + Qt-based viewer for receptive fields, stimuli, activity traces, and decoders

  • Efficient Algorithms
    Fast NumPy and SciPy implementations tailored for neuroscience use cases

Implemented Algorithms

Receptual provides the following out-of-the-box:

  • Receptive field estimation
  • Linear activity encoding

Installation

Receptual requires Python 3.13 or later and is available on PyPI:

# Using uv
uv venv $HOME/venvs/receptual --python 3.13 # or wherever you keep your environments
source $HOME/venvs/receptual/bin/activate
uv pip install receptual

# Using conda
conda create -n receptual python=3.13
conda activate receptual
pip install receptual

Quick Start

Launch the visualization tool with:

receptual

Or use the algorithms yourself:

import receptual
activity = receptual.encoder(stimulus, receptive_field)

Documentation

For detailed usage instructions, examples, and API reference, please visit our documentation.

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

receptual-0.1.0.tar.gz (18.8 MB view details)

Uploaded Source

Built Distribution

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

receptual-0.1.0-py3-none-any.whl (52.0 kB view details)

Uploaded Python 3

File details

Details for the file receptual-0.1.0.tar.gz.

File metadata

  • Download URL: receptual-0.1.0.tar.gz
  • Upload date:
  • Size: 18.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.6.14

File hashes

Hashes for receptual-0.1.0.tar.gz
Algorithm Hash digest
SHA256 8e17145d30af2ec37f42f5c5a343446be4e6b70af04864eccd5aa60da2c48097
MD5 f9fa4418a71f95bd314737ee88a7db81
BLAKE2b-256 7791d986154c5dae50a922ef20bf413a47f1fae48735627fd5dde418ea15cdfa

See more details on using hashes here.

File details

Details for the file receptual-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: receptual-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 52.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.6.14

File hashes

Hashes for receptual-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8d507de19d942c9b5a45a923c0fd78896a1d01d5804b7ab4f9f1c666d3c3f0d1
MD5 c0748f7e4ce660f0adc6791bed1be9f0
BLAKE2b-256 ec312f1be1f7e0c3c18285739145fb1d11f0691bedb9e0ce8f8dac4926170dbe

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