Installation
Requirements
electroMICA requires Python 3.7+ and the following packages:
Core:
numpy,scipy,pandas,nibabelNeuroimaging:
antspyx(ANTsPy, may require system dependencies)Optional:
vtk,pyvirtualdisplay(for visualization on headless systems)Documentation:
sphinx,sphinx-rtd-theme(only for building docs)
Prerequisites
Before using electroMICA, you must run micapipe on your structural MRI data. electroMICA depends on micapipe derivatives (T1w images, cortical surfaces, transforms).
Optionally, you can also run hippunfold to include hippocampal surfaces.
Installation Steps
Clone or download the repository (if not already done):
git clone https://github.com/MICA-MNI/electroMICA.git cd electroMICA
Create a virtual environment (recommended):
python -m venv .venv
Activate the virtual environment:
On Linux/macOS:
source .venv/bin/activate
On Windows (PowerShell):
.\.venv\Scripts\Activate.ps1
Install dependencies from
requirements.txt:pip install --upgrade pip pip install -r requirements.txt
This installs all core and optional dependencies for running electroMICA.
Verify installation:
python -c "import electroMICA; print('electroMICA imported successfully')"
Or run a test script:
python example_electroMICA_iEEG.py
Troubleshooting
- ANTsPy installation issues
antspyx(imported asantsin the code) may require additional system-level dependencies. On Ubuntu/Debian:sudo apt-get install libltdl-devOn macOS: Installation via conda may work better:conda install -c conda-forge antspyx- Sphinx documentation build fails
Ensure
sphinxandsphinx-rtd-themeare installed. If issues persist:pip install --upgrade sphinx sphinx-rtd-theme
- MRI/surface loading errors
Ensure your BIDS/micapipe derivatives are in the correct format. Check: - T1w image exists at
<derivatives>/sub-XX/anat/- Surface files at<derivatives>/sub-XX/surf/
Development Installation
If you plan to contribute to electroMICA:
git clone https://github.com/MICA-MNI/electroMICA.git
cd electroMICA
python -m venv .venv
source .venv/bin/activate # or .\.venv\Scripts\Activate.ps1 on Windows
pip install -r requirements.txt
See Contributing to electroMICA for contribution guidelines.