cerelink 8.1.0

No project description provided

cerelink

This is a Python wrapper for the CereLink (cbsdk) library to configure, pull data, and receive callbacks from Blackrock Neurotech devices.

Note: If you do not require Central running on the same computer as your Python Blackrock device client, then consider instead using pycbsdk.

Getting Started

• Download a wheel from the releases page or build it yourself.
• Activate a Python environment with pip, Cython, and numpy
• Install the wheel: python -m pip install path\to\filename.whl
• Test with python -c "from cerelink import cbpy; cbpy.open(parameter=cbpy.defaultConParams())"
  • You might get RuntimeError: -30, Instrument is offline.. That's OK, depending on your device and network settings.
• See cerebuswrapper for a tool that provides a simplified interface to cerelink.

Build Instructions

• If you haven't already, build and install CereLink following the main BUILD instructions.
  • Windows: If using Visual Studio then close it.
• Open a Terminal or Anaconda prompt and activate your Python environment.
• Your Python environment's Python interpreter (CPython, arch, version) must match that of the eventual machine that will run the package, and it must already have Cython, numpy, pip, setuptools, and wheel installed.
  • We do not set these as explicit dependencies on the package to avoid bundling them so you must install manually.
  • python -m ensurepip
  • python -m pip install --upgrade pip setuptools wheel cython numpy
• Change to the CereLink directory.
• Install locally: python -m pip install bindings/Python
• or, if you are making a wheel to bring to another machine,
  • activate an environment matching the target machine,
  • python -m pip wheel bindings/Python -w bindings/Python/dist
  • The wheels will be in the bindings/Python/dist folder.
  • See the Wiki for more information.

NumPy Compatibility

This project is built against NumPy 2.x. Users must have NumPy 2.0 or later installed. If you are having trouble, try to run the following command and report your results: python -c "import numpy; print(f'NumPy: {numpy.__version__}'); from cerelink import cbpy; print('Success!')"

If you need to support older NumPy 1.x versions, you can build wheels with:

[build-system]
requires = ["setuptools", "wheel", "cython", "oldest-supported-numpy", "setuptools-scm"]

[project]
dependencies = [
  "numpy>=1.23.0,<2.0",
]