pyrception 0.2.4__tar.gz

pyrception-0.2.4/LICENCE.md

@@ -0,0 +1,19 @@
+Copyright (c) 2022-2024 Alexander Hadjiivanov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyrception-0.2.4/PKG-INFO

@@ -0,0 +1,38 @@
+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/README.md

@@ -0,0 +1,64 @@
+# Overview
+Pyrception aims to serve as a simulation and conversion framework for different perceptual modalities. Currently, it supports simulation of visual pathways of the mammalian retina, but the goal is to incorporate other modalities as well, 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.
+
+At this stage, only the visual package is implemented. The auditory and olfactory packages are work in progress. Contributions are welcome in case you would like to help with the implementation of these modalities!
+
+## Installation
+
+You can install Pyrception from PyPI, or directly from GitHub.
+
+### PyPI
+
+```shell
+pip install pyrception
+```
+
+### GitHub
+
+Clone the repository and install it (optionally in in development mode):
+
+=== "HTTPS"
+
+    ``` shell
+    git clone https://github.com/cantordust/pyrception.git
+    ```
+
+=== "Git+SSH"
+
+    ``` shell
+    git clone git@github.com:cantordust/pyrception.git
+    ```
+
+``` shell
+cd pyrception
+```
+``` shell
+pip install -e .
+```
+
+### Documentation
+
+To generate the documentation, run the MkDocs build pipeline:
+
+```shell
+mkdocs build
+```
+
+To view the documentation locally, start the MkDocs server:
+
+```shell
+mkdocs serve
+```
+
+# ToDo
+
+## Short-term
+Visual package:
+- [X] Receptor signal scaling following Weber's law.
+- [X] Retinal ganglion cells.
+- [ ] Saccadic movements (WIP).
+- [ ] Colour vision (with colour opponency).
+- [ ] Auditory package (WIP).
+- [ ] Olfactory package (WIP).
+- [ ] Investigate 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.

pyrception-0.2.4/pyproject.toml

@@ -0,0 +1,72 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+packages = ["pyrception"]
+
+[project]
+authors = [{ name = "Alexander Hadjiivanov" }]
+name = "pyrception"
+version = "0.2.4"
+requires-python = ">= 3.11"
+dependencies = [
+    "av",
+    "black",
+    "h5py",
+    "imageio[ffmpeg]",
+    "ipykernel",
+    "ipywidgets",
+    "loguru",
+    "matplotlib",
+    "numpy",
+    "opencv-python",
+    "plotly[express]",
+    "pydantic-settings",
+    "rich",
+    "ruff",
+    "scikit-image",
+    "scipy",
+    "tqdm",
+]
+
+[project.optional-dependencies]
+gui = ["pyqtgraph", "PySide6"]
+cli = ["cloup"]
+events = ["tonic"]
+dev = ["py-spy"]
+docs = [
+    "mike",
+    "mkdocs-jupyter",
+    "mkdocs-material",
+    "mkdocs",
+    "mkdocstrings[python]",
+]
+
+[project.scripts]
+pyrception = "pyrception.gui.main:run"
+
+[tool.ruff.format]
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+docstring-code-format = false
+docstring-code-line-length = "dynamic"
+
+[tool.ruff.lint.isort]
+from-first = false
+force-single-line = true
+force-sort-within-sections = true
+length-sort = true
+lines-after-imports = 1
+order-by-type = true
+forced-separate = [
+    "future",
+    "typing",
+    "standard-library",
+    "third-party",
+    "first-party",
+    "local-folder",
+    "pyrception",
+]
+relative-imports-order = "closest-to-furthest"

pyrception-0.2.4/pyrception/__init__.py

@@ -0,0 +1,15 @@
+from pyrception.utils.types import InputType
+from pyrception.utils.types import RFArrangement
+from pyrception.utils.types import KernelFilter
+from pyrception.utils.types import KernelShape
+from pyrception.utils.types import Dim
+from pyrception.utils.types import Dims
+from pyrception.config.settings import conf
+from pyrception.config.settings import Conf
+from pyrception.config.settings import logger
+from pyrception.utils.functions import timestamp
+# from pyrception.utils.functions import plot
+# from pyrception.utils.functions import animate
+from pyrception.utils.functions import cartesian_prod
+from pyrception.utils.functions import load_image
+from pyrception.utils.functions import load_video

pyrception-0.2.4/pyrception.egg-info/PKG-INFO

@@ -0,0 +1,38 @@
+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/pyrception.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENCE.md
+README.md
+pyproject.toml
+pyrception/__init__.py
+pyrception.egg-info/PKG-INFO
+pyrception.egg-info/SOURCES.txt
+pyrception.egg-info/dependency_links.txt
+pyrception.egg-info/entry_points.txt
+pyrception.egg-info/requires.txt
+pyrception.egg-info/top_level.txt

pyrception-0.2.4/pyrception.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pyrception-0.2.4/pyrception.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pyrception = pyrception.gui.main:run

pyrception-0.2.4/pyrception.egg-info/requires.txt

@@ -0,0 +1,37 @@
+av
+black
+h5py
+imageio[ffmpeg]
+ipykernel
+ipywidgets
+loguru
+matplotlib
+numpy
+opencv-python
+plotly[express]
+pydantic-settings
+rich
+ruff
+scikit-image
+scipy
+tqdm
+
+[cli]
+cloup
+
+[dev]
+py-spy
+
+[docs]
+mike
+mkdocs-jupyter
+mkdocs-material
+mkdocs
+mkdocstrings[python]
+
+[events]
+tonic
+
+[gui]
+pyqtgraph
+PySide6

pyrception-0.2.4/pyrception.egg-info/top_level.txt

@@ -0,0 +1 @@
+pyrception

pyrception-0.2.4/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+