v0.0.2

What's Changed

• ENH: sensor space noise by @ctrltz in #58
• DOC: add sidebar links to class methods by @ctrltz in #63
• ENH: adjustment of global sensor-space SNR by @ctrltz in #64
• ENH: plot source configuration by @ctrltz in #59
• ENH: set a custom spatial distribution of source variances by @ctrltz in #66
• PERF: speed up the calculation of sensor-space variance by @ctrltz in #68
• DOC: update docstring of SourceConfiguration.to_raw by @ctrltz in #70
• DOC: set up Sphinx gallery for examples by @ctrltz in #72
• ENH: set phase-phase coupling by adding noise to the shifted copy of input waveform by @ctrltz in #71
• ENH: convert sources to mne.Label by @ctrltz in #73
• DOC: add the version switcher dropdown by @ctrltz in #75
• ENH: allow setting the std parameter using SourceEstimate by @ctrltz in #67
• FIX: fix a bug with random_state that causes sources to have same location/waveforms by @ctrltz in #76
• MAINT: cleanup dummy structures used in tests by @ctrltz in #77
• ENH: provide quick access to the simulated sources by @ctrltz in #82
• FIX: band-limited coupling for shifted copy with noise by @ctrltz in #88
• ENH: control amplitude envelope of the coupled waveform by @ctrltz in #87
• FIX: provide subject and subjects_dir for patch generation by @ctrltz in #85
• DOC: showcasing new features & how to cite by @ctrltz in #79
• Prepare the v0.0.2 release by @ctrltz in #91

Full Changelog: v0.0.1...v0.0.2

v0.0.2-rc2

Triggering the release mechanism of Zenodo to check that the citation was updated correctly

v0.0.2-rc1

Triggering the release mechanism of Zenodo to get the DOI for citation

v0.0.1

Added

• SourceSimulator class that allows adding point and patch sources with custom locations and waveforms to the simulation
• Template waveforms of white noise, narrowband oscillation (white noise filtered in a narrow frequency band) and 1/f noise with adjustable slope
• Random vertices in the whole source space or in a subset of vertices as location for point sources
• Adjustment of the SNR of the sources based on sensor space power
• Phase-phase coupling with a constant phase lag or a probabilistic phase lag according to the von Mises distribution
• Traversal of the coupling graph to ensure that the coupling is set up correctly when multiple connectivity edges are defined