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.1.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.1-py3-none-any.whl (52.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: receptual-0.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 fb27761147e3412d8ffc26debc001392fceb9dd40f63620cfe62e2247c2bfd4b
MD5 ee8ede17867f70deabd7607b9235027c
BLAKE2b-256 87e2f11e43a33ca2b1c4987a7f709094bc08b48e23a2153e6b6058fb68f7a2d8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: receptual-0.1.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6b12b2a4bc93d6411b345c39259ecefecf81135437fce9cf41a9a34272690ac6
MD5 213aa916d3994780c9513d2da659b7b7
BLAKE2b-256 a2a708f5f65cd603773945011daf4547adf0e5cd76303cc53a9b2e0b7bd9aafd

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