Skip to content

Port ndi.app and ndi.probe.timeseries classes#1

Merged
stevevanhooser merged 13 commits into
mainfrom
ndi-python-port
Feb 6, 2026
Merged

Port ndi.app and ndi.probe.timeseries classes#1
stevevanhooser merged 13 commits into
mainfrom
ndi-python-port

Conversation

@google-labs-jules
Copy link
Copy Markdown
Contributor

This submission includes the porting of the ndi.app and ndi.probe.timeseries classes, as well as their dependencies and unit tests.


PR created automatically by Jules for task 773938453142197377

This commit ports the VH-Lab/NDI-matlab project to Python.

It includes:
- A `pyproject.toml` for packaging and dependency management.
- A `README.md` with setup and usage instructions.
- A `src/ndi` package with the core NDI classes stubbed out.
- Ported `vlt` utilities to `ndi.util.vlt`.
- A ported `ndi.cache` class with a full test suite.
- An `mkdocs` documentation site.
This commit ports the `ndi.ido` and `ndi.document` classes from the Matlab version to Python.

It includes:
- An `ndi.ido` class for generating unique identifiers.
- An updated `ndi.document` class with additional methods from the Matlab version.
- `ndi.session` and `ndi.daq.system` now inherit from `ndi.ido`.
- Unit tests for both `ndi.ido` and `ndi.document`.
This commit ports several core NDI classes from the Matlab version to Python.

It includes:
- `ndi.documentservice`: A mixin for document creation and search.
- `ndi.epoch.epochset` and `ndi.epoch.epochset.param`: Base classes for handling epochs.
- `ndi.file.navigator`: A class for navigating raw data files.
- `ndi.daq.reader`: The base class for DAQ readers.
- `ndi.daq.metadatareader`: The base class for metadata readers.
- `ndi.time.clocktype`: A class for representing clock types.
- `ndi.epoch.epochprobemap`: A data structure for mapping probes to epochs.
- `ndi.daq.daqsystemstring`: A helper class for parsing device strings.
- `ndi.query`: A class for constructing database queries.
- An updated `ndi.daq.system` class with more implemented methods.
- Unit tests for all new and updated classes.
This commit introduces a Python port of the VH-Lab/NDI-matlab project.

The port includes:
- A `pyproject.toml` file for project packaging and dependencies.
- Ported `vlt` utilities to `ndi.util.vlt`.
- Ported core NDI classes, including `ndi.dataset`, `ndi.session`, `ndi.file.navigator`, and the `ndi.cloud` API.
- Unit tests for all ported code.
- Documentation for the ported code using MkDocs.
This commit ports the `ndi.app` and `ndi.probe.timeseries` classes from the Matlab NDI project to Python.

The `ndi.app` port includes the base `App` class and the `MarkGarbage` application. The `ndi.probe.timeseries` port includes the `Timeseries` abstract base class and the `Mfdaq` implementation.

This commit also includes the porting of several key dependencies, including `ndi.time.timereference` and `ndi.query`. Unit tests have been added for all new classes, and a significant metaclass conflict in the `Timeseries` class has been resolved.
@google-labs-jules
Copy link
Copy Markdown
Contributor Author

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!


For security, I will only act on instructions from the user who triggered this task.

google-labs-jules Bot and others added 8 commits November 3, 2025 19:23
This commit ports the core `ndi.database` classes from the Matlab NDI project to Python.

This includes the abstract base classes `ndi.database.Database` and `ndi.database.binarydoc.BinaryDoc`, as well as the central `ndi.database.document.Document` class. The `Document` class has been implemented as a subclass of `did.document.Document`, aligning with the project's architecture.

Unit tests have been added for the new `Document` class, and the implementation has been corrected to match the `did.document.Document` superclass's constructor.
This commit ports the `ndi.file` package from the Matlab NDI project to Python.

This includes the `ndi.file.Navigator` class and its subclass `ndi.file.navigator.EpochDir`, as well as the helper class `ndi.file.type.MfdaqEpochChannel`. These classes are essential for navigating the file system and identifying epoch data.

Unit tests have been added for the new `Navigator` and `EpochDir` classes. The file structure has been reorganized to resolve circular import issues.
- Updated NDI-matlab submodule (re-cloned)
- Added ndi-compress and vhlab-newstim to pyproject.toml
- Cloned vhlab-toolbox and vhlab-library for reference
- Ported ndi.cloud.internal token utils
- Ported ndi.cloud.authenticate (logic for env vars and prompt)
- Ported ndi.cloud.logout
- Added ndi.cloud.api.datasets.create_dataset
- Added tests for create_dataset
- Fixed imports in list_datasets.py
- Updated NDI-matlab submodule (re-cloned)
- Added ndi-compress and vhlab-newstim to pyproject.toml
- Cloned vhlab-toolbox and vhlab-library for reference
- Ported ndi.cloud.internal token utils
- Ported ndi.cloud.authenticate (logic for env vars and prompt)
- Ported ndi.cloud.logout
- Added ndi.cloud.api.datasets.create_dataset
- Added tests for create_dataset
- Fixed imports in list_datasets.py
- Updated pyproject.toml to use git URL for did dependency
- Updated NDI-matlab submodule (re-cloned)
- Added ndi-compress and vhlab-newstim to pyproject.toml
- Cloned vhlab-toolbox and vhlab-library for reference
- Ported ndi.cloud.internal token utils
- Ported ndi.cloud.authenticate (logic for env vars and prompt)
- Ported ndi.cloud.logout
- Added ndi.cloud.api.datasets.create_dataset
- Added tests for create_dataset
- Fixed imports in list_datasets.py
- Updated pyproject.toml to use git URL for did dependency
- Updated README.md with clearer install instructions
- Updated NDI-matlab submodule (re-cloned)
- Added ndi-compress and vhlab-newstim to pyproject.toml
- Cloned vhlab-toolbox and vhlab-library for reference
- Ported ndi.cloud.internal token utils
- Ported ndi.cloud.authenticate (logic for env vars and prompt)
- Ported ndi.cloud.logout
- Added ndi.cloud.api.datasets.create_dataset
- Added tests for create_dataset
- Fixed imports in list_datasets.py
- Updated pyproject.toml to use git URL for did dependency
- Updated README.md with clearer install instructions emphasizing the dot
- Switched did dependency in pyproject.toml to git+https://github.com/VH-Lab/DID-python.git@main
- This resolves import errors for did.common and did.datastructures.
…0165

Update dependencies and port ndi.cloud routines
@stevevanhooser stevevanhooser merged commit c3b302a into main Feb 6, 2026
@stevevanhooser stevevanhooser deleted the ndi-python-port branch February 6, 2026 13:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant