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.2.tar.gz (6.9 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.2-py3-none-any.whl (52.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for receptual-0.1.2.tar.gz
Algorithm Hash digest
SHA256 1a91d583f68d8da3fdc281db1313b97be6ef433551ae4e33e161151dee93a2f2
MD5 2849b0e2730a8fd438afc6eca8ecbc3f
BLAKE2b-256 815d04bca280ed9126d964eda6b63011d2e0b4ee90a0e5edc99a831e12d926ec

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for receptual-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 08d2b6a2a46dfaaefc22be22dcf4bb2b223cde1e8ad0b7b04acca2a9e9fbab6a
MD5 7428bb0686d6b81be6cc18b35b430e19
BLAKE2b-256 a67a9258f5a3f84a78722ead187c38f522d02eba02ba1b3219208e03e1c1199d

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