Getting Started Guide
From download to your first experiment in under 30 minutes.
Requirements
| Requirement | Minimum | Recommended |
|---|---|---|
| RAM | 8 GB | 16 GB+ |
| Storage | 5 GB free | 20 GB+ (for datasets) |
| CPU | 4-core x86-64 | 8-core+ (faster batch training) |
| GPU | Not required | NVIDIA CUDA (PyTorch acceleration) |
| OS | Windows 10, macOS 12, Ubuntu 20.04 | Windows 11, macOS 14, Ubuntu 22.04 |
| Internet | For install & account only | For cloud sync & community pipelines |
Download & Install
Go to bcinexus.io/download, select your OS, and download the installer (~800 MB).
Windows
- Run BCILattice-Setup.exe
- Accept the license agreement and choose an install location (default:
C:\Program Files\BCILattice\) - Allow PostgreSQL installation when prompted by Windows Firewall
- Launch BCILattice, check the bottom status bar shows Server: Running
macOS
- Open BCILattice.dmg and drag BCILattice.app to Applications
- First launch: right-click → Open (macOS Gatekeeper bypass, only needed once)
- Allow BCILattice through the Firewall when prompted (for the local backend)
- Apple Silicon (M1/M2/M3) is supported natively with Metal acceleration
Linux
chmod +x BCILattice-installer.AppImage
./BCILattice-installer.AppImageWorks on any modern Linux distro (glibc 2.31+). No root access required.
Create an Account
BCILattice works fully offline. A free BCINexus account is optional but unlocks cloud backup, 340+ community pipelines, and team collaboration.
- Click Sign In / Create Account in BCILattice top-right
- Or register at bcinexus.io/register
- Verify your email, then sign in inside BCILattice
You can skip this and start immediately, add an account later in Settings.
Import Your First Dataset
Don't have data yet? Download a free 10-subject EEG motor imagery sample at bcinexus.io/sample-data.
Single file:
- Click Data Manager in the left sidebar
- Click Import Files → select your EEG/fNIRS/EMG file
- BCILattice previews signal + metadata, confirm label column
- Click Add to Session
Multi-subject folder:
- Click Import Folder → select root directory
- Set folder depth (1–5 levels) → BCILattice scans recursively
- Set session name and label config → click Import All
| Modality | Supported Formats |
|---|---|
| EEG | EDF · BDF · GDF · FIF · VHDR · SET · CNT · CSV · XLSX |
| fNIRS | SNIRF · FIF · TXT · CSV · XLSX |
| EMG | EDF · BDF · GDF · FIF · TXT · CSV |
Configure Preprocessing
Click Preprocessing in the left sidebar. Quick-start settings for EEG:
| Setting | Recommended Start |
|---|---|
| Bandpass filter | 0.5 – 40 Hz |
| Notch filter | 50 Hz (EU) · 60 Hz (USA) |
| Re-referencing | CAR (Common Average Reference) |
| Resampling | 250 Hz (if original > 500 Hz) |
Click Preview to see before/after, then Apply to Session.
For fNIRS: enable the one-click TDDR → OD → Beer-Lambert pipeline toggle.
For EMG: enable full-wave rectification + envelope extraction.
Design a Paradigm with NeuralFlow
Click Neural Flow. Drag blocks from the left palette onto the timeline canvas.
5-minute motor imagery paradigm:
- Drag Start Trial block (code -1)
- Drag Visual Cue (2 s), prompt the subject
- Drag MI Left Hand (4 s) · MI Right Hand (4 s)
- Drag Rest (2 s), inter-trial rest
- Drag End Trial block (code -2)
- Wrap steps 2–4 in a Loop Block, set Total Repeat to 20
- Click Compile → Export → .nflow
Build & Train a Machine Learning Pipeline
Click ML Suite. Drag blocks from the catalog panel, connect ports, then compile and train.
Simple EEG classification pipeline:
- Drag Channel Selection block, connects to your imported session
- Drag StandardScaler → connect to Channel Selection output
- Drag EEGNet (or LDA Classifier for a fast baseline) → connect to scaler
- Drag accuracy_score block → connect to classifier output
- Click Workflow Designer tab → assign subjects to the pipeline
- Click Compile (Ctrl+Shift+B) then Train
The Batch Training Dashboard opens with live per-subject progress. Training runs on your local CPU or NVIDIA GPU.
Review Results in Experiment Hub
- Click Experiment Hub, completed run appears as v1
- Click any row to see per-subject accuracy, F1, AUC
- Change a parameter in ML Suite → compile → train → results appear as v2
- Select v1 and v2 → click Compare for side-by-side
- Right-click → Restore to roll back any previous configuration
Generate a Report
- Click Reports → Generate Report
- Choose HTML or PDF
- Report includes: session metadata, preprocessing config, NeuralFlow paradigm, per-subject results
- HTML reports are standalone, email them directly
Keyboard shortcut: Ctrl+R / Cmd+R
Explore Community Pipelines
- Go to bcinexus.io/pipelines
- Browse 340+ pipelines by modality or task (motor imagery, P300, SSVEP…)
- Click Import into BCILattice, BCILattice opens and imports the pipeline automatically
Keyboard Shortcuts
| Action | Windows/Linux | macOS |
|---|---|---|
| New session | Ctrl+N | Cmd+N |
| Save session | Ctrl+S | Cmd+S |
| Open session | Ctrl+O | Cmd+O |
| NeuralFlow compile | Ctrl+B | Cmd+B |
| ML Suite compile | Ctrl+Shift+B | Cmd+Shift+B |
| Generate report | Ctrl+R | Cmd+R |
Troubleshooting
| Problem | Fix |
|---|---|
| "Server: Not Running" | Another process may be using the port. Restart BCILattice. |
| Import fails "unsupported format" | Verify file is not corrupted. Check extension matches actual format. Convert to EDF. |
| Training is very slow | GPU not detected. Check View → System Info. Install CUDA matching your driver. |
| NeuralFlow compile error | Port type mismatch. Check colour-coded port indicators on blocks. |