From 1870f5899b1f3399a677fc8dd4ea1cd6e6c45229 Mon Sep 17 00:00:00 2001 From: Circle Ci Date: Fri, 19 Jul 2024 01:18:21 +0000 Subject: [PATCH] doc updates [skip ci] --- dev/.buildinfo | 2 +- .../read_bids_datasets.ipynb | 2 +- .../auto_examples_python.zip | Bin 100022 -> 100040 bytes .../bidspath.ipynb | 2 +- .../bidspath.py | 2 +- .../read_bids_datasets.py | 2 +- .../update_bids_datasets.ipynb | 2 +- .../auto_examples_jupyter.zip | Bin 154541 -> 154559 bytes .../update_bids_datasets.py | 2 +- dev/_modules/index.html | 8 +- dev/_modules/mne_bids/copyfiles.html | 8 +- dev/_modules/mne_bids/dig.html | 8 +- dev/_modules/mne_bids/inspect.html | 8 +- dev/_modules/mne_bids/path.html | 16 +- dev/_modules/mne_bids/read.html | 8 +- dev/_modules/mne_bids/report/_report.html | 8 +- dev/_modules/mne_bids/sidecar_updates.html | 8 +- dev/_modules/mne_bids/stats.html | 8 +- dev/_modules/mne_bids/utils.html | 8 +- dev/_modules/mne_bids/write.html | 16 +- dev/_static/documentation_options.js | 2 +- dev/api.html | 8 +- dev/authors.html | 8 +- dev/auto_examples/anonymize_dataset.html | 70 +- dev/auto_examples/bidspath.html | 10 +- dev/auto_examples/convert_eeg_to_bids.html | 884 +++++++++++++++++- dev/auto_examples/convert_empty_room.html | 10 +- dev/auto_examples/convert_group_studies.html | 16 +- dev/auto_examples/convert_ieeg_to_bids.html | 185 +++- dev/auto_examples/convert_mne_sample.html | 56 +- dev/auto_examples/convert_mri_and_trans.html | 10 +- dev/auto_examples/convert_nirs_to_bids.html | 22 +- dev/auto_examples/create_bids_folder.html | 10 +- dev/auto_examples/mark_bad_channels.html | 10 +- dev/auto_examples/read_bids_datasets.html | 350 ++++++- .../rename_brainvision_files.html | 8 +- dev/auto_examples/sg_execution_times.html | 56 +- dev/auto_examples/update_bids_datasets.html | 87 +- dev/contribute.html | 8 +- dev/generated/cli.html | 20 +- dev/generated/mne_bids.BIDSPath.html | 12 +- dev/generated/mne_bids.anonymize_dataset.html | 8 +- .../mne_bids.convert_montage_to_mri.html | 8 +- .../mne_bids.convert_montage_to_ras.html | 8 +- ...e_bids.copyfiles.copyfile_brainvision.html | 8 +- .../mne_bids.copyfiles.copyfile_bti.html | 8 +- .../mne_bids.copyfiles.copyfile_ctf.html | 8 +- .../mne_bids.copyfiles.copyfile_edf.html | 8 +- .../mne_bids.copyfiles.copyfile_eeglab.html | 8 +- .../mne_bids.copyfiles.copyfile_kit.html | 8 +- .../mne_bids.find_matching_paths.html | 10 +- .../mne_bids.get_anat_landmarks.html | 8 +- .../mne_bids.get_anonymization_daysback.html | 8 +- .../mne_bids.get_bids_path_from_fname.html | 8 +- dev/generated/mne_bids.get_datatypes.html | 8 +- .../mne_bids.get_entities_from_fname.html | 8 +- dev/generated/mne_bids.get_entity_vals.html | 8 +- .../mne_bids.get_head_mri_trans.html | 8 +- dev/generated/mne_bids.inspect_dataset.html | 8 +- .../mne_bids.make_dataset_description.html | 8 +- dev/generated/mne_bids.make_report.html | 8 +- dev/generated/mne_bids.mark_channels.html | 8 +- dev/generated/mne_bids.print_dir_tree.html | 8 +- dev/generated/mne_bids.read_raw_bids.html | 8 +- .../mne_bids.search_folder_for_text.html | 8 +- .../mne_bids.stats.count_events.html | 10 +- dev/generated/mne_bids.template_to_head.html | 8 +- .../mne_bids.update_anat_landmarks.html | 8 +- .../mne_bids.update_sidecar_json.html | 8 +- dev/generated/mne_bids.write_anat.html | 8 +- .../mne_bids.write_meg_calibration.html | 8 +- .../mne_bids.write_meg_crosstalk.html | 8 +- dev/generated/mne_bids.write_raw_bids.html | 13 +- dev/genindex.html | 8 +- dev/index.html | 8 +- dev/install.html | 8 +- dev/objects.inv | Bin 3759 -> 3759 bytes dev/py-modindex.html | 8 +- dev/search.html | 8 +- dev/searchindex.js | 2 +- dev/sg_execution_times.html | 56 +- dev/use.html | 8 +- dev/whats_new.html | 13 +- dev/whats_new_previous_releases.html | 20 +- 84 files changed, 1889 insertions(+), 475 deletions(-) diff --git a/dev/.buildinfo b/dev/.buildinfo index eba07e810..177311ba7 100644 --- a/dev/.buildinfo +++ b/dev/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 88be86eb1ead2c30bf7578c466dc42db +config: 7e827f982bf71cd0f6a2c7d255480056 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/dev/_downloads/07841a9269d1816a3add41f32d8a5ed2/read_bids_datasets.ipynb b/dev/_downloads/07841a9269d1816a3add41f32d8a5ed2/read_bids_datasets.ipynb index 3e55048a8..9dae3b0aa 100644 --- a/dev/_downloads/07841a9269d1816a3add41f32d8a5ed2/read_bids_datasets.ipynb +++ b/dev/_downloads/07841a9269d1816a3add41f32d8a5ed2/read_bids_datasets.ipynb @@ -58,7 +58,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "## Explore the dataset contents\n\nWe can use MNE-BIDS to print a tree of all\nincluded files and folders. We pass the ``max_depth`` parameter to\n`mne_bids.print_dir_tree` to the output to four levels of folders, for\nbetter readability in this example.\n\n" + "## Explore the dataset contents\n\nWe can use MNE-BIDS to print a tree of all\nincluded files and folders. We pass the ``max_depth`` parameter to\n:func:`mne_bids.print_dir_tree` to the output to four levels of folders, for\nbetter readability in this example.\n\n" ] }, { diff --git a/dev/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip b/dev/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip index 003544785436c917a4d34dc5020548a5cf4e6fac..0f9081f9bf1ff04ef5f6b90b8923a889a5df47fb 100644 GIT binary patch delta 442 zcmdni%XXrdjW@uXnMH&F1defj-pG4WmU%ko=gl`|=V&u`0~r;b#r(|1K*qa>EIDRt zAS1ebzXG!@8%_^-lFWGAIi4%u} zn0Es;^xoEC=LIq%0`C_7<&+>J|mG)gp2tMQ0e+?Mjvrzp!=u)YhttqxoNsX zGov%e1Jm0;44?<5pJ`@v0C`|Ke+#1{$OF@ZTcC=kwlKP(dSLpC7Dh9Wqo*sjGDwmo8K!J)t6uK{LIW%Z?=bV zF-{2ttC!l)b!;X-1H;Vi-=i7VvQ9pCLVNqwM8=n#%sfDK2eTP{#6cEJ7iea*2RUkb zP&1=5$i35NfEYj@OuyI6=l~W`Y+-Z+`Cxi#3smv)7DhK-6dz3g)xu~d4|3^&6?0Dg zVPjwbVNq~EL5MAl4b%Nw8C7ghyaV(SH;SV5j~Ez|GE<5R5=%1l3MvD<8JR?wAps8b z>h$%kjM9v^r=JEIBoFj)#MLw54M~AOEkG=eVvy~0zBWcRMUZXqzyJmas-i2=jMM){ wGfGU)ZDZsC1b&zz2jInHd<~H!%Wv0J?9p*8l(j diff --git a/dev/_downloads/0c7e85abda2fce1fe2c484ad9f9aaa81/bidspath.ipynb b/dev/_downloads/0c7e85abda2fce1fe2c484ad9f9aaa81/bidspath.ipynb index 1ccfd3f46..9c04f1e6b 100644 --- a/dev/_downloads/0c7e85abda2fce1fe2c484ad9f9aaa81/bidspath.ipynb +++ b/dev/_downloads/0c7e85abda2fce1fe2c484ad9f9aaa81/bidspath.ipynb @@ -112,7 +112,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "Now that was easy! We're almost there! We also need to specify a\n**data type**, i.e., ``meg`` for MEG data, ``eeg`` and ``ieeg`` for EEG and\niEEG data, or ``anat`` for anatomical MRI scans. Typically, MNE-BIDS will\ninfer the data type of your data automatically, for example when writing data\nusing `mne_bids.write_raw_bids`. For the sake of this example, however, we\nare going to specify the data type explicitly.\n\n" + "Now that was easy! We're almost there! We also need to specify a\n**data type**, i.e., ``meg`` for MEG data, ``eeg`` and ``ieeg`` for EEG and\niEEG data, or ``anat`` for anatomical MRI scans. Typically, MNE-BIDS will\ninfer the data type of your data automatically, for example when writing data\nusing :func:`mne_bids.write_raw_bids`. For the sake of this example, however, we\nare going to specify the data type explicitly.\n\n" ] }, { diff --git a/dev/_downloads/4b11a3ce6cfd9d8cf2b976f8386a2f8f/bidspath.py b/dev/_downloads/4b11a3ce6cfd9d8cf2b976f8386a2f8f/bidspath.py index fac85e9a9..943821398 100644 --- a/dev/_downloads/4b11a3ce6cfd9d8cf2b976f8386a2f8f/bidspath.py +++ b/dev/_downloads/4b11a3ce6cfd9d8cf2b976f8386a2f8f/bidspath.py @@ -81,7 +81,7 @@ # **data type**, i.e., ``meg`` for MEG data, ``eeg`` and ``ieeg`` for EEG and # iEEG data, or ``anat`` for anatomical MRI scans. Typically, MNE-BIDS will # infer the data type of your data automatically, for example when writing data -# using `mne_bids.write_raw_bids`. For the sake of this example, however, we +# using :func:`mne_bids.write_raw_bids`. For the sake of this example, however, we # are going to specify the data type explicitly. datatype = "eeg" diff --git a/dev/_downloads/5eebd75ee4f8ffd30e34a83e87d0e28b/read_bids_datasets.py b/dev/_downloads/5eebd75ee4f8ffd30e34a83e87d0e28b/read_bids_datasets.py index b0d03ed95..00263d3b8 100644 --- a/dev/_downloads/5eebd75ee4f8ffd30e34a83e87d0e28b/read_bids_datasets.py +++ b/dev/_downloads/5eebd75ee4f8ffd30e34a83e87d0e28b/read_bids_datasets.py @@ -78,7 +78,7 @@ # # We can use MNE-BIDS to print a tree of all # included files and folders. We pass the ``max_depth`` parameter to -# `mne_bids.print_dir_tree` to the output to four levels of folders, for +# :func:`mne_bids.print_dir_tree` to the output to four levels of folders, for # better readability in this example. print_dir_tree(bids_root, max_depth=4) diff --git a/dev/_downloads/6a10915cde9ea548655ec1feef4a85d1/update_bids_datasets.ipynb b/dev/_downloads/6a10915cde9ea548655ec1feef4a85d1/update_bids_datasets.ipynb index 9b8c0aedf..dfaeb0f8b 100644 --- a/dev/_downloads/6a10915cde9ea548655ec1feef4a85d1/update_bids_datasets.ipynb +++ b/dev/_downloads/6a10915cde9ea548655ec1feef4a85d1/update_bids_datasets.ipynb @@ -58,7 +58,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "## Explore the dataset contents\n\nWe can use MNE-BIDS to print a tree of all\nincluded files and folders. We pass the ``max_depth`` parameter to\n`mne_bids.print_dir_tree` to the output to three levels of folders, for\nbetter readability in this example.\n\n" + "## Explore the dataset contents\n\nWe can use MNE-BIDS to print a tree of all\nincluded files and folders. We pass the ``max_depth`` parameter to\n:func:`mne_bids.print_dir_tree` to the output to three levels of folders, for\nbetter readability in this example.\n\n" ] }, { diff --git a/dev/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip b/dev/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip index b62937be2b79b4594466583d564d13f996201ef0..43b4b524de3766bca23a35c1381e20aeeb63dab4 100644 GIT binary patch delta 515 zcmY+AO(?8U7{||fjwWx-JH*sA-h7ONMqIkd*JOc|EJ(@wz7w~blG(V6OUg!5cV`wP zJt+%gA(@a2Cy`kw3e84QWKCHpL)r11p{Y6boc@d7^YQ<0N-Zumy{|`PxtV>5?CP z@`-gVx!dGhZWBo2W^Bd~4J54pqF&6B_`UaDFIq|14{H^Qk;28F^Yvd^(mdPtH%96h zi^vZzA9gxgMkmKdTI5hIA1xP$gr4^E0hdn7G&Eljs~JOC^@lI!Ep)!+;@^3mBd`B) z@TB0oFh4042h|66vr|fDpOF}9XTW}{bHdXIA%kUS53O=^GwYZGo~tY(ruXIQ4E&{07K~Y+*KJ z{sd&iZ~XybL_J@o22!(~nUC?kFz>6%HxU9oI$LHNFfh#C{$G(Xj%WH(Stjl6eR_=6 zD$HzEZ?>NaVhrWu1+pUU{RqvTsLjAIal2k3<5Z#Pg%cSiw?8UoWRe6ceBQ%&SdN($ zsAcVHMvhFdmM>w7A!gDH3})L8i7?&e*bX$iMTi;b=F+jBAA>(?w|fEg2@HUaEt^h2B~R_Wb#CH{`5PMOqPluhtB-s#HPf@ zzyQJ$;9!CfTN-x;F;2e|#3(u4KZ=P*9>r5Yj{%j#!InnB=~YoovLLTbpB2R<&3JD5 zwkRfbkO!wf0P&|x{}aWe2{r`oO`un$;6^YoY-yZ7-6fhy6YS4|XrLzE={?a*x@>#G HnSjawWc8iz diff --git a/dev/_downloads/8a652dc37d1d38cf986f15eab46d0f7d/update_bids_datasets.py b/dev/_downloads/8a652dc37d1d38cf986f15eab46d0f7d/update_bids_datasets.py index 23a693348..9e2383972 100644 --- a/dev/_downloads/8a652dc37d1d38cf986f15eab46d0f7d/update_bids_datasets.py +++ b/dev/_downloads/8a652dc37d1d38cf986f15eab46d0f7d/update_bids_datasets.py @@ -48,7 +48,7 @@ # # We can use MNE-BIDS to print a tree of all # included files and folders. We pass the ``max_depth`` parameter to -# `mne_bids.print_dir_tree` to the output to three levels of folders, for +# :func:`mne_bids.print_dir_tree` to the output to three levels of folders, for # better readability in this example. print_dir_tree(bids_root, max_depth=3) diff --git a/dev/_modules/index.html b/dev/_modules/index.html index bee1f8580..7e4d471cb 100644 --- a/dev/_modules/index.html +++ b/dev/_modules/index.html @@ -7,7 +7,7 @@ - Overview: module code — MNE-BIDS 0.16.0.dev11+gdbdf957f documentation + Overview: module code — MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation @@ -40,7 +40,7 @@ - + @@ -147,7 +147,7 @@ -

MNE-BIDS 0.16.0.dev11+gdbdf957f documentation

+

MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation

@@ -564,7 +564,7 @@

All modules for which code is available

- © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-12. + © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-19.

diff --git a/dev/_modules/mne_bids/copyfiles.html b/dev/_modules/mne_bids/copyfiles.html index 1a7bcb552..a72ff6f3c 100644 --- a/dev/_modules/mne_bids/copyfiles.html +++ b/dev/_modules/mne_bids/copyfiles.html @@ -7,7 +7,7 @@ - mne_bids.copyfiles — MNE-BIDS 0.16.0.dev11+gdbdf957f documentation + mne_bids.copyfiles — MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation @@ -40,7 +40,7 @@ - + @@ -147,7 +147,7 @@ -

MNE-BIDS 0.16.0.dev11+gdbdf957f documentation

+

MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation

@@ -1211,7 +1211,7 @@

Source code for mne_bids.copyfiles

 
   

     
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-12.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-19.
       

     
   

diff --git a/dev/_modules/mne_bids/dig.html b/dev/_modules/mne_bids/dig.html
index 794a82bb6..ad5511374 100644
--- a/dev/_modules/mne_bids/dig.html
+++ b/dev/_modules/mne_bids/dig.html
@@ -7,7 +7,7 @@
   
     
     
-    mne_bids.dig — MNE-BIDS 0.16.0.dev11+gdbdf957f documentation
+    mne_bids.dig — MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation
   
   
   
@@ -40,7 +40,7 @@
 
   
 
-    
+    
     
     
     
@@ -147,7 +147,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev11+gdbdf957f documentation

+    
MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation
@@ -1357,7 +1357,7 @@

Source code for mne_bids.dig

 
   

     
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-12.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-19.
       

     
   

diff --git a/dev/_modules/mne_bids/inspect.html b/dev/_modules/mne_bids/inspect.html
index 6b993acfd..67296a49c 100644
--- a/dev/_modules/mne_bids/inspect.html
+++ b/dev/_modules/mne_bids/inspect.html
@@ -7,7 +7,7 @@
   
     
     
-    mne_bids.inspect — MNE-BIDS 0.16.0.dev11+gdbdf957f documentation
+    mne_bids.inspect — MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation
   
   
   
@@ -40,7 +40,7 @@
 
   
 
-    
+    
     
     
     
@@ -147,7 +147,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev11+gdbdf957f documentation

+    
MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation
@@ -1012,7 +1012,7 @@

Source code for mne_bids.inspect

 
   

     
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-12.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-19.
       

     
   

diff --git a/dev/_modules/mne_bids/path.html b/dev/_modules/mne_bids/path.html
index 54965e72d..03d0177dc 100644
--- a/dev/_modules/mne_bids/path.html
+++ b/dev/_modules/mne_bids/path.html
@@ -7,7 +7,7 @@
   
     
     
-    mne_bids.path — MNE-BIDS 0.16.0.dev11+gdbdf957f documentation
+    mne_bids.path — MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation
   
   
   
@@ -40,7 +40,7 @@
 
   
 
-    
+    
     
     
     
@@ -147,7 +147,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev11+gdbdf957f documentation

+    
MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation
@@ -1432,7 +1432,7 @@

Source code for mne_bids.path

             If a boolean, controls whether to enforce BIDS conformity. This
             will set the ``.check`` attribute accordingly. If ``None``, rely on
             the existing ``.check`` attribute instead, which is set upon
-            `mne_bids.BIDSPath` instantiation. Defaults to ``None``.
+            :class:`mne_bids.BIDSPath` instantiation. Defaults to ``None``.
         **kwargs : dict
             It can contain updates for valid BIDSPath entities:
             'subject', 'session', 'task', 'acquisition', 'processing', 'run',
@@ -1552,7 +1552,7 @@ 
Source code for mne_bids.path
         check : bool
             If ``True``, only returns paths that conform to BIDS. If ``False``
             (default), the ``.check`` attribute of the returned
-            `mne_bids.BIDSPath` object will be set to ``True`` for paths that
+            :class:`mne_bids.BIDSPath` object will be set to ``True`` for paths that
             do conform to BIDS, and to ``False`` for those that don't.
 
         Returns
@@ -2947,7 +2947,7 @@ 
Source code for mne_bids.path
     check : bool
         If ``True``, only returns paths that conform to BIDS. If ``False``
         (default), the ``.check`` attribute of the returned
-        `mne_bids.BIDSPath` object will be set to ``True`` for paths that
+        :class:`mne_bids.BIDSPath` object will be set to ``True`` for paths that
         do conform to BIDS, and to ``False`` for those that don't.
 
     Returns
@@ -3025,7 +3025,7 @@ 
Source code for mne_bids.path
     check : bool
         If ``True``, only returns paths that conform to BIDS. If ``False``
         (default), the ``.check`` attribute of the returned
-        `mne_bids.BIDSPath` object will be set to ``True`` for paths that
+        :class:`mne_bids.BIDSPath` object will be set to ``True`` for paths that
         do conform to BIDS, and to ``False`` for those that don't.
 
     Returns
@@ -3094,7 +3094,7 @@ 
Source code for mne_bids.path
 
   

     
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-12.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-19.
       

     
   

diff --git a/dev/_modules/mne_bids/read.html b/dev/_modules/mne_bids/read.html
index 683c6e1b4..52f25c20a 100644
--- a/dev/_modules/mne_bids/read.html
+++ b/dev/_modules/mne_bids/read.html
@@ -7,7 +7,7 @@
   
     
     
-    mne_bids.read — MNE-BIDS 0.16.0.dev11+gdbdf957f documentation
+    mne_bids.read — MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation
   
   
   
@@ -40,7 +40,7 @@
 
   
 
-    
+    
     
     
     
@@ -147,7 +147,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev11+gdbdf957f documentation

+    
MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation

   
 

     
@@ -1742,7 +1742,7 @@ 
Source code for mne_bids.read
 
   

     
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-12.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-19.
       

     
   

diff --git a/dev/_modules/mne_bids/report/_report.html b/dev/_modules/mne_bids/report/_report.html
index 0cea84fed..c058b0e58 100644
--- a/dev/_modules/mne_bids/report/_report.html
+++ b/dev/_modules/mne_bids/report/_report.html
@@ -7,7 +7,7 @@
   
     
     
-    mne_bids.report._report — MNE-BIDS 0.16.0.dev11+gdbdf957f documentation
+    mne_bids.report._report — MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation
   
   
   
@@ -40,7 +40,7 @@
 
   
 
-    
+    
     
     
     
@@ -147,7 +147,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev11+gdbdf957f documentation

+    
MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation

   
 

     
@@ -1098,7 +1098,7 @@ 
Source code for mne_bids.report._report
 
   

     
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-12.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-19.
       

     
   

diff --git a/dev/_modules/mne_bids/sidecar_updates.html b/dev/_modules/mne_bids/sidecar_updates.html
index 9a330ae19..da7778979 100644
--- a/dev/_modules/mne_bids/sidecar_updates.html
+++ b/dev/_modules/mne_bids/sidecar_updates.html
@@ -7,7 +7,7 @@
   
     
     
-    mne_bids.sidecar_updates — MNE-BIDS 0.16.0.dev11+gdbdf957f documentation
+    mne_bids.sidecar_updates — MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation
   
   
   
@@ -40,7 +40,7 @@
 
   
 
-    
+    
     
     
     
@@ -147,7 +147,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev11+gdbdf957f documentation

+    
MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation

   
 

     
@@ -949,7 +949,7 @@ 
Source code for mne_bids.sidecar_updates
 
   

     
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-12.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-19.
       

     
   

diff --git a/dev/_modules/mne_bids/stats.html b/dev/_modules/mne_bids/stats.html
index e698296fd..d092449de 100644
--- a/dev/_modules/mne_bids/stats.html
+++ b/dev/_modules/mne_bids/stats.html
@@ -7,7 +7,7 @@
   
     
     
-    mne_bids.stats — MNE-BIDS 0.16.0.dev11+gdbdf957f documentation
+    mne_bids.stats — MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation
   
   
   
@@ -40,7 +40,7 @@
 
   
 
-    
+    
     
     
     
@@ -147,7 +147,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev11+gdbdf957f documentation

+    
MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation

   
 

     
@@ -689,7 +689,7 @@ 
Source code for mne_bids.stats
 
   

     
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-12.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-19.
       

     
   

diff --git a/dev/_modules/mne_bids/utils.html b/dev/_modules/mne_bids/utils.html
index 4e653acc0..5131b3a17 100644
--- a/dev/_modules/mne_bids/utils.html
+++ b/dev/_modules/mne_bids/utils.html
@@ -7,7 +7,7 @@
   
     
     
-    mne_bids.utils — MNE-BIDS 0.16.0.dev11+gdbdf957f documentation
+    mne_bids.utils — MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation
   
   
   
@@ -40,7 +40,7 @@
 
   
 
-    
+    
     
     
     
@@ -147,7 +147,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev11+gdbdf957f documentation

+    
MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation

   
 

     
@@ -1097,7 +1097,7 @@ 
Source code for mne_bids.utils
 
   

     
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-12.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-19.
       

     
   

diff --git a/dev/_modules/mne_bids/write.html b/dev/_modules/mne_bids/write.html
index c870cc75e..0652c17c1 100644
--- a/dev/_modules/mne_bids/write.html
+++ b/dev/_modules/mne_bids/write.html
@@ -7,7 +7,7 @@
   
     
     
-    mne_bids.write — MNE-BIDS 0.16.0.dev11+gdbdf957f documentation
+    mne_bids.write — MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation
   
   
   
@@ -40,7 +40,7 @@
 
   
 
-    
+    
     
     
     
@@ -147,7 +147,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev11+gdbdf957f documentation

+    
MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation

   
 

     
@@ -529,7 +529,7 @@ 
Source code for mne_bids.write
 import sys
 import warnings
 from collections import OrderedDict, defaultdict
-from datetime import datetime, timedelta, timezone
+from datetime import date, datetime, timedelta, timezone
 from pathlib import Path
 
 import mne
@@ -974,12 +974,14 @@ 
Source code for mne_bids.write
 
         # determine the age of the participant
         age = subject_info.get("birthday", None)
+        if isinstance(age, tuple):  # can be removed once MNE >= 1.8 is required
+            age = date(*age)
         meas_date = raw.info.get("meas_date", None)
         if isinstance(meas_date, (tuple, list, np.ndarray)):
             meas_date = meas_date[0]
 
         if meas_date is not None and age is not None:
-            bday = datetime(age[0], age[1], age[2], tzinfo=timezone.utc)
+            bday = datetime(age.year, age.month, age.day, tzinfo=timezone.utc)
             if isinstance(meas_date, datetime):
                 meas_datetime = meas_date
             else:
@@ -1931,7 +1933,7 @@ 
Source code for mne_bids.write
         already loaded from disk unless ``allow_preload`` is explicitly set
         to ``True``. See warning for the ``allow_preload`` parameter.
     bids_path : BIDSPath
-        The file to write. The `mne_bids.BIDSPath` instance passed here
+        The file to write. The :class:`mne_bids.BIDSPath` instance passed here
         **must** have the ``subject``, ``task``, and ``root`` attributes set.
         If the ``datatype`` attribute is not set, it will be inferred from the
         recording data type found in ``raw``. In case of multiple data types,
@@ -3723,7 +3725,7 @@ 
Source code for mne_bids.write
 
   

     
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-12.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-19.
       

     
   

diff --git a/dev/_static/documentation_options.js b/dev/_static/documentation_options.js
index 683867597..e3a2cb1bb 100644
--- a/dev/_static/documentation_options.js
+++ b/dev/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.16.0.dev11+gdbdf957f',
+    VERSION: '0.16.0.dev13+gaf12bc47',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',
diff --git a/dev/api.html b/dev/api.html
index 0b3a1cbdc..bbbe042d1 100644
--- a/dev/api.html
+++ b/dev/api.html
@@ -8,7 +8,7 @@
     
     
 
-    API Documentation — MNE-BIDS 0.16.0.dev11+gdbdf957f documentation
+    API Documentation — MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation
   
   
   
@@ -41,7 +41,7 @@
 
   
 
-    
+    
     
     
     
@@ -150,7 +150,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev11+gdbdf957f documentation

+    
MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation

   
 

     
@@ -779,7 +779,7 @@ 
mne_bids.copyfiles
     
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-12.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-19.
       

     
   

diff --git a/dev/authors.html b/dev/authors.html
index 5cb1c6336..5c27e2400 100644
--- a/dev/authors.html
+++ b/dev/authors.html
@@ -8,7 +8,7 @@
     
     
 
-    <no title> — MNE-BIDS 0.16.0.dev11+gdbdf957f documentation
+    <no title> — MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation
   
   
   
@@ -41,7 +41,7 @@
 
   
 
-    
+    
     
     
     
@@ -148,7 +148,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev11+gdbdf957f documentation

+    
MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation

   
 

     
@@ -575,7 +575,7 @@
 
   

     
-      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-12.
+      © Copyright 2017, The MNE-BIDS developers. Last updated on 2024-07-19.
       

     
   

diff --git a/dev/auto_examples/anonymize_dataset.html b/dev/auto_examples/anonymize_dataset.html
index f94a3da75..5e8b5e7d8 100644
--- a/dev/auto_examples/anonymize_dataset.html
+++ b/dev/auto_examples/anonymize_dataset.html
@@ -8,7 +8,7 @@
     
     
 
-    13. Anonymizing a BIDS dataset — MNE-BIDS 0.16.0.dev11+gdbdf957f documentation
+    13. Anonymizing a BIDS dataset — MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation
   
   
   
@@ -41,7 +41,7 @@
 
   
 
-    
+    
     
     
     
@@ -151,7 +151,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev11+gdbdf957f documentation

+    
MNE-BIDS 0.16.0.dev13+gaf12bc47 documentation

   
 

     
@@ -675,7 +675,7 @@ 
Basic anonymizationSpecifying subject IDsSpecifying subject IDsSpecifying subject IDs

 

 
@@ -930,9 +930,9 @@ 
ReproducibilityTotal running time of the script: (0 minutes 11.205 seconds)

+
Total running time of the script: (0 minutes 12.149 seconds)

 

 

-
Total running time of the script: (0 minutes 1.872 seconds)

+
Total running time of the script: (0 minutes 2.156 seconds)
+
Downloading EEGBCI data
+Download complete in 11s (7.4 MB)
+Downloading EEGBCI data
+Download complete in 11s (7.3 MB)
+
+

Let us loop over the subjects and create BIDS-compatible folder

# Make a path where we can save the data to
 bids_root = op.join(mne_data_dir, "eegmmidb_bids_group_conversion")
@@ -952,7 +958,7 @@
 0.0 were removed from analysis).
-

Total running time of the script: (0 minutes 1.270 seconds)

+

Total running time of the script: (0 minutes 23.980 seconds)

This should be very similar to the ds000248 dataset_description.json!

-

Total running time of the script: (0 minutes 3.683 seconds)

+

Total running time of the script: (0 minutes 3.890 seconds)