Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

MEEGsim

DOI

Overview

MEEGsim is a Python package that provides template waveforms for simulating M/EEG data with known ground truth source activity. In addition, it simplifies the manipulation of relevant simulation parameters (e.g., signal-to-noise ratio and source connectivity). As a result, the users can focus on what to simulate, not on how to implement the simulation. The package is compatible with MNE-Python and re-uses the forward and inverse modeling functionality provided by MNE.

Find more details about the package in the documentation. For a brief overview of the functionality, check the poster about MEEGsim that was presented at the CuttingEEGX conference (28-31.10.2024, Nijmegen, The Netherlands, and online).

Development

Creating a Local Copy of the Project

  1. Clone the repository.

  2. Create an environment (conda/mamba/virtualenv).

  3. Switch to the project folder and install the package and all dependencies:

cd meegsim
pip install -e .[dev]
  1. You're ready to start now!

Running Tests

pytest

Building the Documentation

  1. Install the required packages.
pip install -e .[docs]
  1. Build the documentation.
make html
  1. Open it in the web browser.
make show

Download files

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

Source Distribution

meegsim-0.0.3rc1.tar.gz (31.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

meegsim-0.0.3rc1-py3-none-any.whl (37.8 kB view details)

Uploaded Python 3

File details

Details for the file meegsim-0.0.3rc1.tar.gz.

File metadata

  • Download URL: meegsim-0.0.3rc1.tar.gz
  • Upload date:
  • Size: 31.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for meegsim-0.0.3rc1.tar.gz
Algorithm Hash digest
SHA256 d5d7faf6e7b274bcbab55dcbe7284a2a8c013e788dc44176775c1c58789206af
MD5 4dca72283d5d81f376d5b8b99c52b023
BLAKE2b-256 21770cc66bef8a6c06d19ec9bc1193c523cb35e3db1feb5fdc2211fd8b13dd1f

See more details on using hashes here.

Provenance

The following attestation bundles were made for meegsim-0.0.3rc1.tar.gz:

Publisher: release.yml on ctrltz/meegsim

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file meegsim-0.0.3rc1-py3-none-any.whl.

File metadata

  • Download URL: meegsim-0.0.3rc1-py3-none-any.whl
  • Upload date:
  • Size: 37.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for meegsim-0.0.3rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 31b8a13add6760434b7e89e1278841a2aa1608464876609d81cb9355dc092191
MD5 b1480f68685ad3901081a07443ae1cb7
BLAKE2b-256 ed3c313c8d241cc83d9652d4df91166b27008bfb9577807611ad0fc71b891aef

See more details on using hashes here.

Provenance

The following attestation bundles were made for meegsim-0.0.3rc1-py3-none-any.whl:

Publisher: release.yml on ctrltz/meegsim

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.0.3rc1 This release

2 files

0.0.2

2 files

0.0.1

2 files

0.0.0

2 files

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