404
-Page not found
-diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..64da4a6 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,31 @@ +name: CI + +on: + push: + branches: [ main ] + pull_request: + branches: [ main ] + +jobs: + test: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: ["3.10", "3.11"] + + steps: + - uses: actions/checkout@v4 + + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v5 + with: + python-version: ${{ matrix.python-version }} + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install . + + - name: Run tests + run: | + python -m unittest discover -s tests diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml new file mode 100644 index 0000000..34be3c0 --- /dev/null +++ b/.github/workflows/deploy-docs.yml @@ -0,0 +1,27 @@ +name: Deploy Docs + +on: + push: + branches: [ main ] + +permissions: + contents: write + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: 3.x + - name: Install dependencies + run: | + pip install . + - name: Configure Git User + run: | + git config user.name "github-actions[bot]" + git config user.email "github-actions[bot]@users.noreply.github.com" + - name: Deploy + run: mkdocs gh-deploy --force diff --git a/.gitignore b/.gitignore index 813d1b4..1013bf1 100644 --- a/.gitignore +++ b/.gitignore @@ -71,3 +71,4 @@ example/binary_collections/* # symlinked schema */.ndi +site/ diff --git a/DID-python b/DID-python deleted file mode 160000 index 97ba45c..0000000 --- a/DID-python +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 97ba45ccd02a8d8070395a48e5a80e691414253a diff --git a/NDI-compress-python b/NDI-compress-python deleted file mode 160000 index 0c05d9d..0000000 --- a/NDI-compress-python +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 0c05d9dbd63ed5d15866eb1bf0a096568ef0c192 diff --git a/NDI-matlab b/NDI-matlab deleted file mode 160000 index fc99679..0000000 --- a/NDI-matlab +++ /dev/null @@ -1 +0,0 @@ -Subproject commit fc99679a3572881a56c5ae4738bbdaab73fb46fb diff --git a/mkdocs.yml b/mkdocs.yml index e198e3f..f14b5d3 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,6 @@ site_name: NDI-python +theme: + name: material nav: - Home: index.md - Cache: cache.md diff --git a/pyproject.toml b/pyproject.toml index 566bdb0..4e96a4e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -19,6 +19,7 @@ classifiers = [ dependencies = [ "did @ git+https://github.com/VH-Lab/DID-python.git@main", "mkdocs", + "mkdocs-material", "pandas", "requests", "ndi-compress @ git+https://github.com/Waltham-Data-Science/NDI-compress-python", diff --git a/site/404.html b/site/404.html deleted file mode 100644 index 0023f9c..0000000 --- a/site/404.html +++ /dev/null @@ -1,144 +0,0 @@ - - -
- - - - - - - -Page not found
-The ndi.cache module provides a simple in-memory cache for storing data.
Cache classThe 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.
This is the documentation for the Python port of the VH-Lab/NDI-matlab project.
-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.
-To install the package, you can use pip:
-pip install .
-
-import ndi
-