BCILattice User Manual
A practical guide to the NeuroMatrix desktop workflow, from local studies and signal processing to ML Suite, reports, AI Chat, BCINexus sharing, and team collaboration.
Overview
BCILattice is the NeuroMatrix desktop application for BCI and neuroscience research. It is built around a local-first workflow: import recordings, preprocess signals, design paradigms, build ML pipelines, train models, compare experiments, inspect model behavior, and export reports from one study workspace.
The application is visual first, but it is not a black box. Researchers can inspect intermediate outputs, configure preprocessing explicitly, use custom blocks where needed, and keep experiments reproducible through study snapshots, run history, report exports, and BCINexus publishing metadata.
BCILattice vs BCINexus
| Product | Role | Typical Use |
|---|---|---|
| BCILattice | Desktop app | Local data work, preprocessing, Neural Flow, ML Suite, training, analysis, reports, AI Chat, live recording, and edge tools. |
| BCINexus | Cloud/account layer | Sign-in, plan limits, cloud sync, private sharing, team workspaces, public study publishing, review status, and dashboard access. |
Workflow Map
| Stage | Module | Purpose |
|---|---|---|
| 1 | Studies | Create or open a local .blts study. |
| 2 | Data Manager | Import files, subjects, sessions, modalities, and labels. |
| 3 | Preprocessing | Apply non-destructive EEG, fNIRS, EMG, or EOG processing. |
| 4 | Analysis | Inspect features, channel selections, dimensionality reduction, and intermediate figures. |
| 5 | Neural Flow | Design paradigms, cues, task blocks, trial markers, and timing. |
| 6 | ML Suite | Build MLFlow graphs, assign data in Workflow, compile, and train. |
| 7 | Experiment Hub | Track, compare, restore, publish, and export experiment runs. |
| 8 | Results / Model Analysis | Review metrics, SHAP, weights, activation maps, and model diagnostics. |
| 9 | Reports | Generate PDF, HTML, JSON, and CSV outputs for reproducibility and sharing. |
Installation
Download the current installer or package from bcinexus.xyz/download. The desktop app is designed as a cross-platform PySide6 (Qt for Python) application, but the download page is the source of truth for which packaged builds are currently available.
- Use a workstation with at least 8 GB RAM; 16 GB or more is recommended for large multi-subject datasets.
- Use an NVIDIA CUDA GPU when available for faster PyTorch training; CPU training remains supported.
- Keep enough disk space for raw recordings, derived preprocessing outputs, reports, and local study files.
- If you run from source, use the repository dependency files and developer environment instead of the end-user installer instructions.
Account
A BCINexus account is optional for local work and required for cloud-backed features. Sign in when you want to sync a study, publish to the community, create private share links, join a team workspace, or use dashboard/account features.
- Create an account at bcinexus.xyz/register or from the desktop sign-in flow.
- Verify your email if prompted.
- Return to BCILattice and sign in from Settings, Account, or the module that requested authentication.
Cloud quota and plan behavior follow the active workspace. A team study uses the team's plan and quota; a personal study uses your personal account quota.
Studies
Studies are the container for local research work. New study work should use .blts, which stores study metadata and references to the workflow state BCILattice needs to reopen your study.
- Create: open Studies and create a local study with name, modality, task type, and description.
- Open: load a
.bltsfile from the Studies page. - Workspace: use the study workspace to move between Data Manager, Preprocessing, Analysis, Neural Flow, ML Suite, Experiment Hub, Results, Model Analysis, Reports, and publish actions.
- Sync: use explicit cloud sync when you want a selected study package backed up to BCINexus.
.blts.Trained model artifacts are kept in a global per-user store (~/.bcilattice/experiments) and referenced by experiments rather than copied into each study. When you export or share a study as a .bciproj bundle, the referenced artifacts are gathered and restored automatically.
Data Manager
Data Manager is the source for files, subjects, sessions, modalities, labels, and quality checks. Downstream preprocessing, analysis, workflow assignment, and training depend on the records you define here.
Importing Files
- Open the active study workspace and choose Data Manager.
- Import a single file or scan a folder containing subject/session directories.
- Select the modality and confirm labels or label columns.
- Review previews and quality warnings before adding the data to the study.
Supported Formats
| Modality | Supported formats |
|---|---|
| EEG | EDF, BDF, GDF, FIF, VHDR, SET, CNT, TXT, CSV, XLSX |
| fNIRS | SNIRF, FIF, TXT, CSV, XLSX |
| EMG | EDF, BDF, GDF, FIF, TXT, CSV |
| EOG | EDF, BDF, FIF, TXT, CSV, XLSX |
Original recordings are not modified. BCILattice writes derived outputs and study metadata separately.
Preprocessing
Preprocessing applies signal conditioning before feature extraction and training. Use it to create a documented, repeatable transformation path rather than editing raw files manually.
| Modality | Common operations |
|---|---|
| EEG | Bandpass, notch filtering, resampling, re-reference, bad-channel handling, ICA support, label alignment. |
| fNIRS | Optical density conversion, Beer-Lambert conversion, HbO/HbR handling, TDDR/motion correction paths, short-channel regression. |
| EMG | Bandpass, rectification, envelope extraction, RMS envelope, baseline correction. |
| EOG | Filtering, blink annotation, threshold handling. |
Neural Flow
Neural Flow is the visual paradigm designer. Use it to define trial structure, cues, task blocks, rest periods, looped blocks, markers, and timing. The output can be used as a paradigm artifact and as a label/timing reference for downstream work.
- Open Neural Flow from the study workspace.
- Add task, cue, feedback, timing, marker, or loop blocks.
- Set labels, durations, marker codes, and repeat counts.
- Compile the graph and fix any validation errors.
- Export or save the paradigm with the study.
ML Suite
ML Suite is the visual ML area. It includes MLFlow graph editing, Workflow assignment, training dashboards, curated BCILattice blocks, and a larger catalog of scikit-learn, PyTorch, MNE, signal-processing, feature, evaluation, and model components.
- MLFlow: build the graph that defines transforms, models, metrics, and outputs.
- Workflow: assign study data, subjects, sessions, and endpoints to the graph.
- Training: compile, validate, and execute runs with local CPU/GPU resources.
- Custom Code: add controlled custom logic when built-in blocks are not enough.
Workflow & Training
- Start with a simple baseline graph before adding deep models or complex projections.
- Use Workflow to bind files from Data Manager to the graph.
- Compile and fix structural errors before training.
- Run training from the dashboard and monitor per-subject or per-run progress.
- Review metrics in Experiment Hub and Results before making conclusions.
For subject-generalization claims, use validation that respects subject boundaries. For quick debugging, compare a simple LDA/SVM baseline against deep models before tuning architecture.
Experiment Hub
Experiment Hub is the run-history and comparison surface. It stores completed run records, lets you inspect metrics, compare selected runs, export CSV records, restore selected experiment state where available, and publish selected artifacts to BCINexus.
- Use run history to see what changed between training attempts.
- Compare metrics before declaring a model improvement.
- Export CSV when you need external statistical analysis.
- Publish only artifacts that are safe and meaningful for other researchers to reuse.
Analysis & Results
Analysis, Results, and Model Analysis are separate surfaces. Analysis is for signal and feature inspection. Results is for metrics and cross-experiment comparison. Model Analysis is for interpretability and diagnostics such as SHAP, weights, and activation maps where the selected experiment supports them.
| Surface | Use it for |
|---|---|
| Analysis | Artifact review, channel screening, epoching, time-frequency, channel selection, dimensionality reduction, feature extraction, and exploratory figures. |
| Results | Best metrics, run comparison, and high-level experiment outcomes. |
| Model Analysis | Explainability, learned weights, SHAP views, and activation maps. |
The Analysis Suite
Analysis runs as eleven steps in two sections. Prepare cleans the recording and cuts it into trials; Reduce & Extract narrows those trials into the labelled matrix ML Suite trains on. Every step has a View tab for working on one file and an Apply tab for batching the same settings across many, and every step reads a named stage and writes a named stage inside the subject's .bltd container.
| Section | Steps |
|---|---|
| Prepare | ICA Review, Channel Quality, Epoching, Normalization, Augmentation, Activation Maps, Time-Frequency |
| Reduce & Extract | Channels Selection, Dimensionality Reducer, Feature Extraction, Data Projection |
- Pick the modality, session, file, and upstream Source stage.
- Set the step's parameters and run it on that one file.
- Read the result tabs, tables, figures, and the diagnostics that come with them.
- Switch to Apply and batch the same settings across the rest of the dataset.
- Use Methods to draft a Methods paragraph from the recorded provenance.
The seven Prepare steps can be dragged into a different order, and the app remembers it; Reduce & Extract is a fixed dependency chain. Each step's Source dropdown offers only the stages that step is allowed to consume.
Reports
Reports turns the current study document and experiment outputs into shareable files. Use it after the data, preprocessing, workflow, training, and result sections are complete enough to explain.
- Open Reports from the study workspace.
- Generate the report from the current study state.
- Review the generated sections in the editor.
- Export PDF, HTML, JSON, or CSV depending on the recipient.
Use JSON when you need a machine-readable study document and CSV when you need metric tables for external analysis.
AI Chat
AI Chat connects the desktop app to your own AI provider accounts or a local Ollama endpoint. Supported providers are Gemini (Google), ChatGPT (OpenAI), Claude (Anthropic), Mistral, DeepSeek, a free-tier Groq API, and local Ollama. You supply the API key, or run Ollama on your own machine for a fully local model. Answers are grounded in your work through retrieval over app knowledge, your experiments, sessions, and pipelines.
- Connect providers from the AI Chat connection page.
- Use prompt tools to ask about preprocessing, interpretation, reports, or ML troubleshooting.
- Review answers critically before applying them to a research workflow.
- Use local Ollama when you need prompts to stay on your own machine.
Cloud & Sharing
BCINexus cloud features are explicit actions. Signing in does not automatically publish or upload every file in a study.
| Action | What it does |
|---|---|
| Sync Cloud | Backs up a selected study package or study state to BCINexus. |
| Publish | Submits selected artifacts for community visibility or review. |
| Private Share Link | Creates a private cloud link for selected work without listing it publicly. |
| From Community | Imports reusable pipeline artifacts from BCINexus into the local study. |
| Cloud Submissions | Shows publish/review status for submitted work. |
Teams
Teams are BCINexus workspaces for labs and organizations. They add shared quota, members, roles, study sharing, file sharing, dataset manifests, tasks, pages, activity logs, and study requests.
| Plan | Current backend limits |
|---|---|
| Free | 3 uploads/month, 100 MB storage, no team workspace. Two sessions, modalities, pipelines and experiments; unlimited analysis and training inside them. |
| Researcher | 15 uploads/month, 500 MB storage, personal workspace only. No workspace-size caps. |
| Lab | 50 uploads/month, 5 GB shared storage, team workspace, 5 pooled seats across up to 3 teams (extra seats at the Researcher rate). |
| Extra storage | Buy more GB on the same subscription: Researcher $1 per 1 GB / month, Lab $3 per 5 GB / month. Add it at checkout, or later from Billing → Add Storage. |
| Enterprise | Unlimited uploads, from 50 GB storage, contract-defined team seats. |
| Downloads | Unlimited on every plan, including Free. Upload allowances reset on the 1st of each month. |
Training still runs locally on each researcher's machine. Team features coordinate study state, shared artifacts, permissions, and collaboration records.
Privacy
BCILattice is local-first. Imported recordings remain local unless you explicitly choose a cloud, team, share, publish, or AI-provider workflow that sends selected information elsewhere.
- Raw recordings are not uploaded automatically after import.
- Cloud sync and publishing should be treated as explicit data-transfer actions.
- AI Chat with remote providers sends prompt content to that provider endpoint.
- Regulated use depends on your deployment, data handling policy, agreements, and institutional review.
For compliance posture and procurement language, use the Security & Compliance guide rather than assuming the app carries a blanket certification.
Troubleshooting
| Problem | First checks |
|---|---|
| Local server not ready | Restart BCILattice, check logs, and verify no local process is blocking the configured FastAPI port. |
| Import fails | Confirm file extension, modality, label columns, and whether the file opens in a trusted external reader. |
| Preprocessing output looks wrong | Check sampling rate, channel types, filters, label alignment, and whether the original file has mixed units. |
| Graph will not compile | Inspect validation messages, missing parameters, disconnected nodes, and incompatible outputs. |
| Training is slow | Start with a smaller baseline, reduce folds, confirm GPU availability, and inspect data shape. |
| Cloud sync fails | Check sign-in state, active workspace, quota, team permissions, and internet connectivity. |