Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

A tool for electromagnetic modelling of the head and sensitivity analysis.

Project description


PyPI version Python License
Docker Documentation Binder
Code style Doc style

Constructing accurate subject specific head model is of main interest in the fields of source imaging (EEG/MEG) and brain stimulation (tDCS/tMS). shamo is an open source python package to calculate EEG leadfields, current flows, and electric potential distribution in the head. From a labelled 3D image of the head, the whole process is fully automatized, relying only on a few parameter files, e.g. conductivities (including white matter anisotropy) plus source and electrode locations. Since there is no non-invasive method to measure the electromagnetic (EM) properties of the head tissues, shamo can also be used to assess the sensitivity of the EM head model to these parameters.


Before installing shamo, make sure to install the dependencies.

Once done, you can either install it from PyPI:

python3 -m pip install shamo

or from source:

git clone
cd shamo
python3 install

shamo is also available on docker hub in four different images:

  • python-dev and jupyter-dev provide the latest build from the develop branch.
  • python-{tag} and jupyter-{tag} provide builds for corresponding releases. The python images provide a python interpreter with shamo installed where thejupyter images also provide a jupyter lab server.

For more information, see the documentation.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for shamo, version 0.3.2
Filename, size File type Python version Upload date Hashes
Filename, size shamo-0.3.2-py2.py3-none-any.whl (64.4 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size shamo-0.3.2.tar.gz (47.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page