Skip to main content

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

Metadata

Release files for meegsim 0.0.2

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

Source distribution (sdist)

Source distribution for meegsim 0.0.2
File Size Uploaded Provenance Actions
meegsim-0.0.2.tar.gz 31.4 kB Without provenance Details for meegsim-0.0.2.tar.gz

Built distribution (wheel)

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

Total release size: 69.0 kB

Release files / meegsim-0.0.2.tar.gz

Download URL meegsim-0.0.2.tar.gz
Size 31.4 kB
Tags Source
SHA-256 checksum
How to use checksums
295c903303233e48da2e8ca80fc9f01cbb08e1c39ef9a2e5d1603b84b56e7e98
BLAKE2b-256 checksum
How to use checksums
10be837060594ba1eb2cb8b66de07d112d822da3819709d197709616312676e7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.4

Release files / meegsim-0.0.2-py3-none-any.whl

Download URL meegsim-0.0.2-py3-none-any.whl
Size 37.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fa81eb84a7ae203c151f0ef87c6a55c4d8fd39d75accc1cea94ef3b1ab87e587
BLAKE2b-256 checksum
How to use checksums
d5f24fef21c02f189a42f5f7cb981c5d574ebc2e9e7c4bbb2c163944382dd2c5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.4

Security for meegsim 0.0.2

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