Merge pull request #1 from VH-Lab/ndi-python-port

Port `ndi.app` and `ndi.probe.timeseries` classes

Author: stevevanhooser

DID-python

@@ -0,0 +1 @@
+Subproject commit 97ba45ccd02a8d8070395a48e5a80e691414253a

NDI-compress-python

@@ -0,0 +1 @@
+Subproject commit 0c05d9dbd63ed5d15866eb1bf0a096568ef0c192

NDI-matlab

@@ -0,0 +1 @@
+Subproject commit fc99679a3572881a56c5ae4738bbdaab73fb46fb

README.md

@@ -0,0 +1,58 @@
+# NDI-python
+
+A Python port of VH-Lab/NDI-matlab.
+
+## Installation
+
+To install the package, run the following command in the root directory. **Note the dot `.` at the end**, which tells pip to install from the current directory. This will automatically install all required dependencies (including `did`, `ndi-compress`, etc.):
+
+```bash
+pip install .
+```
+
+If you are installing for development (editable mode), use the `-e` flag (again, **note the dot `.` at the end**):
+
+```bash
+pip install -e .
+```
+
+## Usage
+
+```python
+import ndi
+```
+
+## Development
+
+### Environment Setup
+
+To set up the development environment, first create and activate a virtual environment:
+
+```bash
+python3 -m venv venv
+source venv/bin/activate
+```
+
+### Dependency Installation
+
+Install the package in editable mode, which will also install all dependencies:
+
+```bash
+pip install -e .
+```
+
+### Running Tests
+
+To run the tests, use the following command:
+
+```bash
+python -m unittest discover tests
+```
+
+### Building Documentation
+
+To build the documentation, use the following command:
+
+```bash
+mkdocs build
+```

docs/cache.md

@@ -0,0 +1,32 @@
+# ndi.cache
+
+The `ndi.cache` module provides a simple in-memory cache for storing data.
+
+## The `Cache` class
+
+The `Cache` class is used to create a new cache object.
+
+### `__init__(self, maxMemory=10e9, replacement_rule='fifo')`
+
+Creates a new cache object.
+
+*   `maxMemory`: The maximum amount of memory (in bytes) that the cache can use.
+*   `replacement_rule`: The replacement rule to use when the cache is full. Can be `'fifo'`, `'lifo'`, or `'error'`.
+
+### `add(self, key, type, data, priority=0)`
+
+Adds an item to the cache.
+
+*   `key`: The key for the item.
+*   `type`: The type of the item.
+*   `data`: The data to be cached.
+*   `priority`: The priority of the item (higher priority items are less likely to be evicted).
+
+### `lookup(self, key, type)`
+
+Looks up an item in the cache.
+
+*   `key`: The key for the item.
+*   `type`: The type of the item.
+
+Returns the cached item, or `None` if the item is not found.

docs/file.md

@@ -0,0 +1,9 @@
+# File
+
+This package contains classes for file I/O.
+
+## Navigator
+
+`ndi.file.Navigator(session, fileparameters=None, epochprobemap_class=None, epochprobemap_fileparameters=None)`
+
+An object for accessing files on disk.

docs/fun.md

@@ -0,0 +1,21 @@
+# Fun
+
+This package contains utility functions.
+
+## timestamp
+
+`ndi.fun.timestamp.timestamp()`
+
+Returns a current time stamp string.
+
+## name_to_variable_name
+
+`ndi.fun.name_to_variable_name.name_to_variable_name(name)`
+
+Converts a string into a camelCase variable name format.
+
+## channel_name_to_prefix_number
+
+`ndi.fun.channel_name_to_prefix_number.channel_name_to_prefix_number(channel_name)`
+
+Identifies the prefix and number from a channel name string.

docs/index.md

@@ -0,0 +1,21 @@
+# Welcome to NDI-python
+
+This is the documentation for the Python port of the VH-Lab/NDI-matlab project.
+
+## Project Overview
+
+NDI-python is a Python library for interacting with the Neuroscience Data Interface (NDI). It provides a set of tools for managing and analyzing neuroscience data.
+
+## Installation
+
+To install the package, you can use pip:
+
+```bash
+pip install .
+```
+
+## Usage
+
+```python
+import ndi
+```

mkdocs.yml

@@ -0,0 +1,6 @@
+site_name: NDI-python
+nav:
+    - Home: index.md
+    - Cache: cache.md
+    - Fun: fun.md
+    - File: file.md

pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "ndi"
+version = "0.0.1"
+authors = [
+  { name="VH-Lab", email="info@vhlab.org" },
+]
+description = "A Python port of NDI-matlab"
+readme = "README.md"
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "did @ git+https://github.com/VH-Lab/DID-python.git@main",
+    "mkdocs",
+    "pandas",
+    "requests",
+    "ndi-compress @ git+https://github.com/Waltham-Data-Science/NDI-compress-python",
+    "vhlab-newstim @ git+https://github.com/VH-Lab/vhlab-NewStim-python",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/VH-Lab/NDI-python"
+"Bug Tracker" = "https://github.com/VH-Lab/NDI-python/issues"
+
+[tool.hatch.metadata]
+allow-direct-references = true