Documentation Index
Fetch the complete documentation index at: https://docs.nimbusbci.com/llms.txt
Use this file to discover all available pages before exploring further.
Installation
Install the nimbus-bci Python SDK from PyPI and verify your setup.Requirements
Before installing, ensure you have:- Python ≥ 3.11 (Python 3.11, 3.12, or 3.13)
- pip package manager
- 64-bit system (Linux, macOS, or Windows)
The Python SDK does not require an API key. All processing is local.
Install from PyPI
Install the latest stable version from PyPI:- NumPy ≥ 1.26
- scikit-learn ≥ 1.4
- SciPy ≥ 1.17.1
Optional Dependencies
Install optional features as needed:MNE-Python Integration
For EEG preprocessing and feature extraction:- MNE ≥ 1.6
Visualization
For plotting and diagnostics:- Matplotlib ≥ 3.8
Softmax Model
For the optional JAX-basedNimbusSoftmax model:
- JAX ≥ 0.4.25
All Optional Dependencies
Install everything:Development Installation
For development or contributing:- pytest for testing
- Cython for building extensions
- build and twine for packaging
Verify Installation
Test your installation:Platform-Specific Notes
macOS
The package includes universal2 wheels for both Intel and Apple Silicon:Linux
Pre-built wheels for x86_64 and aarch64 use the manylinux_2_28 platform tag:Windows
Pre-built wheels for 64-bit Windows:32-bit systems are not supported. Use 64-bit Python on a 64-bit OS.
Troubleshooting
JAX Installation Issues
JAX is only required forNimbusSoftmax. If JAX installation fails, install it separately first:
Import Errors
If you see import errors, verify dependencies:MNE-Python Conflicts
If you have an existing MNE installation, you may need to upgrade:Upgrading
Upgrade to the latest version:Uninstalling
Remove the package:License
The nimbus-bci Python SDK is proprietary software with the following license tiers:| Tier | Use Case | Cost |
|---|---|---|
| Evaluation | 30-day free trial for R&D | Free |
| Academic | University research | Free |
| Startup | Companies < $1M revenue | Contact us |
| Commercial | Full production rights | Contact us |
| Enterprise | Unlimited deployments + SLA | Contact us |
| OEM/Embedded | Medical devices, FDA support | Contact us |
Request a License
To obtain a license:- Email hello@nimbusbci.com with your use case
- Receive license agreement
- Start building
The evaluation period allows full functionality for 30 days. Academic users receive free licenses for non-commercial research.
What’s Next?
Quickstart
Build your first BCI classifier in 5 minutes
API Reference
Explore the complete API documentation
sklearn Integration
Use nimbus-bci with sklearn pipelines
MNE Integration
Preprocess EEG data with MNE-Python
Support
Need help with installation?- Email: hello@nimbusbci.com
- GitHub Issues: github.com/nimbusbci/nimbuspysdk/issues
- Documentation: Browse our comprehensive guides
Successfully installed? Head to the Quickstart Guide to build your first BCI classifier.