# MEEGsim
## 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](https://meegsim.readthedocs.io/en/latest/). For a brief overview of the functionality, check the [poster](https://drive.google.com/file/d/14KVjHdnnEdUFOrbRWb59Rqsj_cwjElHV/view?usp=sharing) about MEEGsim that was presented at the [CuttingEEGX](https://cuttingeegx.org/) 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:
```bash
cd meegsim
pip install -e .[dev]
```
4. You're ready to start now!
### Running Tests
```
pytest
```
### Building the Documentation
1. Install the required packages.
```bash
pip install -e .[docs]
```
2. Build the documentation.
```bash
make html
```
3. Open it in the web browser.
```bash
make show
```
Raw data
{
"_id": null,
"home_page": null,
"name": "meegsim",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "EEG, MEG, connectivity, simulation",
"author": "Alina Studenova, Mina Jamshidi Idaji",
"author_email": "Nikolai Kapralov <kapralov@cbs.mpg.de>",
"download_url": "https://files.pythonhosted.org/packages/70/08/cd624d98a43506fdadaabb190990129dc148eaaa3d9371fe833460bb5415/meegsim-0.0.1.tar.gz",
"platform": null,
"description": "# MEEGsim\n\n## Overview\n\n**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.\n\nFind more details about the package in the [documentation](https://meegsim.readthedocs.io/en/latest/). For a brief overview of the functionality, check the [poster](https://drive.google.com/file/d/14KVjHdnnEdUFOrbRWb59Rqsj_cwjElHV/view?usp=sharing) about MEEGsim that was presented at the [CuttingEEGX](https://cuttingeegx.org/) conference (28-31.10.2024, Nijmegen, The Netherlands, and online).\n\n## Development\n\n### Creating a Local Copy of the Project\n\n1. Clone the repository.\n\n2. Create an environment (conda/mamba/virtualenv).\n\n3. Switch to the project folder and install the package and all dependencies: \n\n```bash\ncd meegsim\npip install -e .[dev]\n```\n\n4. You're ready to start now!\n\n### Running Tests\n\n```\npytest\n```\n\n### Building the Documentation\n\n1. Install the required packages.\n\n```bash\npip install -e .[docs]\n```\n\n2. Build the documentation.\n\n```bash\nmake html\n```\n\n3. Open it in the web browser.\n\n```bash\nmake show\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Building blocks (waveforms, SNR, connectivity) for M/EEG simulations with MNE-Python",
"version": "0.0.1",
"project_urls": {
"Documentation": "https://meegsim.readthedocs.io/",
"Homepage": "https://github.com/ctrltz/meegsim",
"Issues": "https://github.com/ctrltz/meegsim/issues"
},
"split_keywords": [
"eeg",
" meg",
" connectivity",
" simulation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "de2c16e8693728bcd7f7400941d101b3a6495dd0ae6afa09d786e25e74f2e3c1",
"md5": "935e3d9be357a5d3bc71963f1395e730",
"sha256": "95b8f5d89e016e28d573269e7a3b67a6ace041de5c91dbe59b19c9807f7489d7"
},
"downloads": -1,
"filename": "meegsim-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "935e3d9be357a5d3bc71963f1395e730",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 26845,
"upload_time": "2024-10-31T09:25:50",
"upload_time_iso_8601": "2024-10-31T09:25:50.441107Z",
"url": "https://files.pythonhosted.org/packages/de/2c/16e8693728bcd7f7400941d101b3a6495dd0ae6afa09d786e25e74f2e3c1/meegsim-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7008cd624d98a43506fdadaabb190990129dc148eaaa3d9371fe833460bb5415",
"md5": "f67c54239e8d508ff3b7049a5cea548d",
"sha256": "87dd5b1c3ee439e4196c97705b561695a52379fc89572760caba4fab4da2137b"
},
"downloads": -1,
"filename": "meegsim-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "f67c54239e8d508ff3b7049a5cea548d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 21169,
"upload_time": "2024-10-31T09:25:51",
"upload_time_iso_8601": "2024-10-31T09:25:51.767850Z",
"url": "https://files.pythonhosted.org/packages/70/08/cd624d98a43506fdadaabb190990129dc148eaaa3d9371fe833460bb5415/meegsim-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-31 09:25:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ctrltz",
"github_project": "meegsim",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "meegsim"
}
JSON
