From 1f675fd58798ee36f7ff99b2406242ac08aa1729 Mon Sep 17 00:00:00 2001 From: Nikolai Kapralov <4dvlup@gmail.com> Date: Tue, 19 Aug 2025 00:57:53 +0200 Subject: [PATCH 1/4] Prepare the v0.0.2 release --- CHANGELOG.md | 2 +- docs/changelog/devel.md | 22 ---------------------- docs/changelog/v0.0.2.md | 23 +++++++++++++++++++++++ docs/user_guide/whats_new.rst | 1 + pyproject.toml | 2 +- 5 files changed, 26 insertions(+), 24 deletions(-) create mode 100644 docs/changelog/v0.0.2.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 09f2fda..d7555e7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,7 +6,7 @@ API is defined in the [API reference](https://meegsim.readthedocs.io/en/stable/a The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## Version 0.0.2 (Unreleased) +## Version 0.0.2 (2025-08-XX) ### Added diff --git a/docs/changelog/devel.md b/docs/changelog/devel.md index 0877b09..4046631 100644 --- a/docs/changelog/devel.md +++ b/docs/changelog/devel.md @@ -1,23 +1 @@ # [Unreleased] - -## Added - -- A desired level of white noise can be added in sensor space to model measurement -noise ([#58](https://github.com/ctrltz/meegsim/pull/58)) -- A possibility to plot the source configuration ([#59](https://github.com/ctrltz/meegsim/pull/59)) -- Adjustment of global (all signal vs. all noise sources) SNR ([#64](https://github.com/ctrltz/meegsim/pull/64)) -- Adjustment of the standard deviation of source activity ([#66](https://github.com/ctrltz/meegsim/pull/66)) -- Allow specifying standard deviation via a SourceEstimate object ([#67](https://github.com/ctrltz/meegsim/pull/67)) -- A method for setting phase-phase coupling by adding noise to the shifted copy of input waveform ([#71](https://github.com/ctrltz/meegsim/pull/71)) -- Function to convert the sources to mne.Label ([#73](https://github.com/ctrltz/meegsim/pull/73)) -- Quick dict-like access to the simulated sources ([#82](https://github.com/ctrltz/meegsim/pull/82)) -- Partial control over the amplitude envelope of the coupled waveform: same as input or randomly generated ([#87](https://github.com/ctrltz/meegsim/pull/87)) - -## Changed - -- Reworked normalization of source activity: by default, all source time courses are scaled to make their standard deviation equal to 1 nAm ([#66](https://github.com/ctrltz/meegsim/pull/66)) -- Improved performance when adjusting the SNR for a large number of sources ([#68](https://github.com/ctrltz/meegsim/pull/68)) - -## Fixed - -- Fixed a bug that caused different sources to have the same location and/or waveform when random state was explicitly provided ([#76](https://github.com/ctrltz/meegsim/pull/76)) diff --git a/docs/changelog/v0.0.2.md b/docs/changelog/v0.0.2.md new file mode 100644 index 0000000..36e9d7f --- /dev/null +++ b/docs/changelog/v0.0.2.md @@ -0,0 +1,23 @@ +# Version 0.0.2 (2025-08-XX) + +## Added + +- A desired level of white noise can be added in sensor space to model measurement +noise ([#58](https://github.com/ctrltz/meegsim/pull/58)) +- A possibility to plot the source configuration ([#59](https://github.com/ctrltz/meegsim/pull/59)) +- Adjustment of global (all signal vs. all noise sources) SNR ([#64](https://github.com/ctrltz/meegsim/pull/64)) +- Adjustment of the standard deviation of source activity ([#66](https://github.com/ctrltz/meegsim/pull/66)) +- Allow specifying standard deviation via a SourceEstimate object ([#67](https://github.com/ctrltz/meegsim/pull/67)) +- A method for setting phase-phase coupling by adding noise to the shifted copy of input waveform ([#71](https://github.com/ctrltz/meegsim/pull/71)) +- Function to convert the sources to mne.Label ([#73](https://github.com/ctrltz/meegsim/pull/73)) +- Quick dict-like access to the simulated sources ([#82](https://github.com/ctrltz/meegsim/pull/82)) +- Partial control over the amplitude envelope of the coupled waveform: same as input or randomly generated ([#87](https://github.com/ctrltz/meegsim/pull/87)) + +## Changed + +- Reworked normalization of source activity: by default, all source time courses are scaled to make their standard deviation equal to 1 nAm ([#66](https://github.com/ctrltz/meegsim/pull/66)) +- Improved performance when adjusting the SNR for a large number of sources ([#68](https://github.com/ctrltz/meegsim/pull/68)) + +## Fixed + +- Fixed a bug that caused different sources to have the same location and/or waveform when random state was explicitly provided ([#76](https://github.com/ctrltz/meegsim/pull/76)) diff --git a/docs/user_guide/whats_new.rst b/docs/user_guide/whats_new.rst index 6576d18..849bdf9 100644 --- a/docs/user_guide/whats_new.rst +++ b/docs/user_guide/whats_new.rst @@ -5,4 +5,5 @@ What's new? :maxdepth: 1 ../changelog/devel.md + ../changelog/v0.0.2.md ../changelog/v0.0.1.md diff --git a/pyproject.toml b/pyproject.toml index 01d72e2..062f45a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "hatchling.build" [project] name = "meegsim" -version = "0.0.2dev" +version = "0.0.2" authors = [ { name="Nikolai Kapralov", email="kapralov@cbs.mpg.de" }, { name="Alina Studenova" }, From cf8ae5e91fe4fa10119bc63bba83a2c863fc14de Mon Sep 17 00:00:00 2001 From: Nikolai Kapralov <4dvlup@gmail.com> Date: Tue, 19 Aug 2025 01:05:07 +0200 Subject: [PATCH 2/4] Update versions.json for dropdown --- docs/_static/versions.json | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/_static/versions.json b/docs/_static/versions.json index 6fbe958..ed9260d 100644 --- a/docs/_static/versions.json +++ b/docs/_static/versions.json @@ -1,13 +1,13 @@ [ { - "name": "0.0.2 (dev)", - "version": "dev", - "url": "https://meegsim.readthedocs.io/en/latest/" + "name": "0.0.2 (stable)", + "version": "0.0.2", + "url": "https://meegsim.readthedocs.io/en/stable/", + "preferred": true }, { - "name": "0.0.1 (stable)", + "name": "0.0.1", "version": "0.0.1", - "url": "https://meegsim.readthedocs.io/en/stable/", - "preferred": true + "url": "https://meegsim.readthedocs.io/en/v0.0.1/" } ] From 80e8ced516ee3463de661b34a85a4696ee789861 Mon Sep 17 00:00:00 2001 From: Nikolai Kapralov <4dvlup@gmail.com> Date: Tue, 19 Aug 2025 01:39:01 +0200 Subject: [PATCH 3/4] Update version in CITATION.cff --- CITATION.cff | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CITATION.cff b/CITATION.cff index 52547cf..a73e879 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -33,5 +33,5 @@ keywords: - EEG - connectivity license: BSD-3-Clause -version: 0.0.1 -date-released: '2024-10-31' +version: 0.0.2 +date-released: '2025-08-XX' From 23651d907ac622b805202299b1c3a98c9d3824fd Mon Sep 17 00:00:00 2001 From: Nikolai Kapralov <4dvlup@gmail.com> Date: Mon, 25 Aug 2025 06:41:00 +0200 Subject: [PATCH 4/4] Update the release date --- CHANGELOG.md | 2 +- CITATION.cff | 2 +- docs/changelog/v0.0.2.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d7555e7..e668ab0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,7 +6,7 @@ API is defined in the [API reference](https://meegsim.readthedocs.io/en/stable/a The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## Version 0.0.2 (2025-08-XX) +## Version 0.0.2 (2025-08-25) ### Added diff --git a/CITATION.cff b/CITATION.cff index a73e879..6a6c05a 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -34,4 +34,4 @@ keywords: - connectivity license: BSD-3-Clause version: 0.0.2 -date-released: '2025-08-XX' +date-released: '2025-08-25' diff --git a/docs/changelog/v0.0.2.md b/docs/changelog/v0.0.2.md index 36e9d7f..73d9ec1 100644 --- a/docs/changelog/v0.0.2.md +++ b/docs/changelog/v0.0.2.md @@ -1,4 +1,4 @@ -# Version 0.0.2 (2025-08-XX) +# Version 0.0.2 (2025-08-25) ## Added