pyrception 0.2.4__py3-none-any.whl → 0.2.5__py3-none-any.whl

pyrception-0.2.5.dist-info/METADATA

@@ -0,0 +1,110 @@
+Metadata-Version: 2.4
+Name: pyrception
+Version: 0.2.5
+Author: Alexander Hadjiivanov
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENCE.md
+Requires-Dist: av
+Requires-Dist: black
+Requires-Dist: h5py
+Requires-Dist: imageio[ffmpeg]
+Requires-Dist: ipykernel
+Requires-Dist: ipywidgets
+Requires-Dist: loguru
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Requires-Dist: opencv-python
+Requires-Dist: plotly[express]
+Requires-Dist: pydantic-settings
+Requires-Dist: rich
+Requires-Dist: ruff
+Requires-Dist: scikit-image
+Requires-Dist: scipy
+Requires-Dist: tqdm
+Provides-Extra: gui
+Requires-Dist: pyqtgraph; extra == "gui"
+Requires-Dist: PySide6; extra == "gui"
+Provides-Extra: cli
+Requires-Dist: cloup; extra == "cli"
+Provides-Extra: events
+Requires-Dist: tonic; extra == "events"
+Provides-Extra: dev
+Requires-Dist: py-spy; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mike; extra == "docs"
+Requires-Dist: mkdocs-jupyter; extra == "docs"
+Requires-Dist: mkdocs-material; extra == "docs"
+Requires-Dist: mkdocs; extra == "docs"
+Requires-Dist: mkdocstrings[python]; extra == "docs"
+Dynamic: license-file
+
+[![PyPI - Version](https://img.shields.io/pypi/v/pyrception)](https://pypi.org/project/pyrception/)
+[![Read The Docs](https://readthedocs.org/projects/pyrception/badge/?version=latest)](https://pyrception.readthedocs.io/en/latest/)
+
+# Overview
+Pyrception is a simulation framework for bio-plausible simulation of perceptual modalities. Currently, it supports visual pathways of the mammalian retina, but the long-term goal is to support modalities such as auditory, olfactory and so forth. It can also serve as an input conversion library for encoding raw multimodal sensory input into a uniform spike train suitable for processing with spiking neural networks.
+
+## Installation
+
+You can install Pyrception from PyPI:
+
+```shell
+pip install pyrception
+```
+
+or directly from GitHub (optionally in development mode):
+
+```shell
+git clone git@github.com:cantordust/pyrception.git
+cd pyrception
+pip install -e .
+```
+
+## Usage
+
+Please refer to the [documentation](#documentation), which contains a [step-by-step notebook](docs/docs/notebooks/image.ipynb) demonstrating how to use `pyrception` with a static image. More notebooks are currently being developed, including frame-based RGB input and sparse event input from an event camera. Watch this space.
+
+## Documentation
+
+To generate the documentation, run the MkDocs build pipeline. Note that to build and view the documentation locally, you have to install `pyrception` from GitHub with the optional `docs` modifier:
+
+```shell
+pip install -e .[dev]
+cd docs
+mkdocs build
+```
+
+Then, to view the documentation locally, start the MkDocs server:
+
+```shell
+mkdocs serve
+```
+
+# ToDo
+
+## Short-term
+### Visual package
+- [X] All major types of retinal cells.
+    - [X] Receptors (raw input, Weber's law).
+    - [X] Horizontal cells (mean local brightness, normalising feedback).
+    - [X] Bipolar cells (positive and negative contrast, temporal filter, excitatory input to ganglion cells).
+    - [X] Amacrine cells (inhibitory input to ganglion cells, modulatory signal to bipolar cells).
+    - [X] Ganglion cells (spiking).
+- [X] Logpolar kernel arrangement.
+- [X] Uniform or Gaussian kernels.
+- [X] Arbitrary kernel, size, shape and orientation.
+- [ ] Saccadic movements [WIP].
+- [ ] Colour vision (with colour opponency) [WIP].
+- [ ] Temporal dynamics [WIP].
+- [ ] Events as input [WIP].
+
+### Auditory package
+WIP.
+
+### Olfactory package
+WIP.
+
+### Overall functionality
+- [WIP] Support alternative backends for sparse matrix operations ([CuPy](https://cupy.dev/), [PyTorch](https://pytorch.org/docs/stable/sparse.html), [Sparse](https://sparse.pydata.org/en/stable/)).
+- [ ] Interfacing with (neuromorphic) hardware, such as event cameras.

pyrception-0.2.5.dist-info/RECORD

@@ -0,0 +1,7 @@
+pyrception/__init__.py,sha256=yuzv-s7yWdKB90PRjirO0VbR4cnUJR4k3gIQDVn62ao,699
+pyrception-0.2.5.dist-info/licenses/LICENCE.md,sha256=sMjXzdudBXMsZj3NRSrmovs-xqcYWRmpwUkZmuD8zhA,1070
+pyrception-0.2.5.dist-info/METADATA,sha256=-2UCKzYCSfmZaSCX-rfm9nOctX6BI0kIsHwqxyEZkEg,3812
+pyrception-0.2.5.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+pyrception-0.2.5.dist-info/entry_points.txt,sha256=otFE1Ls0p9Hrb4dXjIRruuSLaUFjsKJDjf9R0tDUxmw,55
+pyrception-0.2.5.dist-info/top_level.txt,sha256=0BQnVt58i3lOTA_eEir2Fz2KxDcruQoBmMAxgMWlfrU,11
+pyrception-0.2.5.dist-info/RECORD,,

{pyrception-0.2.4.dist-info → pyrception-0.2.5.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.0)
+Generator: setuptools (78.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

pyrception-0.2.4.dist-info/METADATA

@@ -1,38 +0,0 @@
-Metadata-Version: 2.2
-Name: pyrception
-Version: 0.2.4
-Author: Alexander Hadjiivanov
-Requires-Python: >=3.11
-License-File: LICENCE.md
-Requires-Dist: av
-Requires-Dist: black
-Requires-Dist: h5py
-Requires-Dist: imageio[ffmpeg]
-Requires-Dist: ipykernel
-Requires-Dist: ipywidgets
-Requires-Dist: loguru
-Requires-Dist: matplotlib
-Requires-Dist: numpy
-Requires-Dist: opencv-python
-Requires-Dist: plotly[express]
-Requires-Dist: pydantic-settings
-Requires-Dist: rich
-Requires-Dist: ruff
-Requires-Dist: scikit-image
-Requires-Dist: scipy
-Requires-Dist: tqdm
-Provides-Extra: gui
-Requires-Dist: pyqtgraph; extra == "gui"
-Requires-Dist: PySide6; extra == "gui"
-Provides-Extra: cli
-Requires-Dist: cloup; extra == "cli"
-Provides-Extra: events
-Requires-Dist: tonic; extra == "events"
-Provides-Extra: dev
-Requires-Dist: py-spy; extra == "dev"
-Provides-Extra: docs
-Requires-Dist: mike; extra == "docs"
-Requires-Dist: mkdocs-jupyter; extra == "docs"
-Requires-Dist: mkdocs-material; extra == "docs"
-Requires-Dist: mkdocs; extra == "docs"
-Requires-Dist: mkdocstrings[python]; extra == "docs"

pyrception-0.2.4.dist-info/RECORD

@@ -1,7 +0,0 @@
-pyrception/__init__.py,sha256=yuzv-s7yWdKB90PRjirO0VbR4cnUJR4k3gIQDVn62ao,699
-pyrception-0.2.4.dist-info/LICENCE.md,sha256=sMjXzdudBXMsZj3NRSrmovs-xqcYWRmpwUkZmuD8zhA,1070
-pyrception-0.2.4.dist-info/METADATA,sha256=7tqh2OZCH1TT_rTvK_jsYNUlvJT09wU6s-VMS75Uddo,1068
-pyrception-0.2.4.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-pyrception-0.2.4.dist-info/entry_points.txt,sha256=otFE1Ls0p9Hrb4dXjIRruuSLaUFjsKJDjf9R0tDUxmw,55
-pyrception-0.2.4.dist-info/top_level.txt,sha256=0BQnVt58i3lOTA_eEir2Fz2KxDcruQoBmMAxgMWlfrU,11
-pyrception-0.2.4.dist-info/RECORD,,