Skip to main content

laMEG

Toolbox for laminar inference with MEG, powered by FreeSurfer and SPM

PyPI version DOI Unit tests codecov linting: pylint Python 3.7 License: GPL v3 Repo Size PyPI - Downloads

Operating system

  • Windows: Tested on WSL (using Ubuntu 24.04.1), follow instructions here

  • Mac: May work, not tested

  • Linux: Tested on Ubuntu and Debian

Requirements

Upgrade Notice (v0.1.0)

If you used laMEG versions prior to v0.1.0, the internal format of laminar surface directories has changed. They are now stored within <SUBJECTS_DIR>/<subject_id>/surf/laminar, and <SUBJECTS_DIR>/<subject_id>/mri/orig.mgz is automatically used for co-registration. Older surfaces must be converted before they can be loaded with the new LayerSurfaceSet interface.

Run the conversion script:

python convert_legacy_surfaces.py <subject_id> <path_to_old_lameg_surf_dir>

For example:

python convert_legacy_surfaces.py sub-104 /data/old_surfaces/sub-104

This will rebuild the standardized hierarchy under:

<SUBJECTS_DIR>/<subject_id>/surf/laminar

and generate complete metadata for each processing stage.

After conversion, you can validate the new structure:

from lameg.surf import LayerSurfaceSet
surf_set = LayerSurfaceSet('sub-104', 11)
surf_set.validate()

Installation

  1. Install git and curl if needed:

    sudo apt-get install git curl
  2. Create a conda environment:

    conda create -n <env name> python=3.7

    replacing <env name> with the name of the environment you would like to create (i.e. ‘lameg’, or the name of your project)

  3. Activate the environment:

    conda activate <env name>

    replacing <env name> with name of the environment you created.

  4. Install FreeSurfer, following the instructions on this page

  5. To install laMEG, run:

    pip install lameg

    Then run the post-installation script:

    lameg-postinstall

    This installs SPM standalone and Matlab runtime, which can take some time depending on your connection speed.

  6. Before using, deactivate and reactivate the environment for changes to environment variables to take effect:

    conda deactivate
    conda activate <env name>
  7. If you want to run the tutorials, download and extract the test data

Documentation and Tutorials

Once you have installed laMEG, check out the example notebooks, tutorials, and documentation. For guidelines on MRI sequences, head-cast construction, and co-registration, see the wiki

Funding

Supported by the European Research Council (ERC) under the European Union’s Horizon 2020 research and innovation programme grant agreement 864550, a French National Research Agency (ANR) grant HiFi (ANR-20-CE17-0023), and a seed grant from the Fondation pour l’Audition.

ERC ANR FPA

Metadata

Release files for lameg 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for lameg 0.2.0
File Size Uploaded Provenance Actions
lameg-0.2.0.tar.gz 13.8 MB Without provenance Details for lameg-0.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for lameg 0.2.0
File Interpreter ABI Platform Actions
lameg-0.2.0-py3-none-any.whl Python 3 none any Details for lameg-0.2.0-py3-none-any.whl

Total release size: 27.6 MB

Release files / lameg-0.2.0.tar.gz

Download URL lameg-0.2.0.tar.gz
Size 13.8 MB
Tags Source
SHA-256 checksum
How to use checksums
5877f51936dfbefda1dd4ac68748d0471a0ac0c8d584b48aab3ee1b98902b2e1
BLAKE2b-256 checksum
How to use checksums
84d6dc5f0c8ca9724a31548d5af57a139f2ea48ce1db9eac32f2db0f6f2a89d3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.7.17

Release files / lameg-0.2.0-py3-none-any.whl

Download URL lameg-0.2.0-py3-none-any.whl
Size 13.8 MB
Tags Python 3
SHA-256 checksum
How to use checksums
e311ff4aa385c51fa7aad589a0253cf24843c009b25c413b0cca4377d6831d7e
BLAKE2b-256 checksum
How to use checksums
3d6f8db11a1b6c78ebca27040827fc8ab8bcc706fed25013e7b99fc341f42edc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.7.17

Security for lameg 0.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page