From 28972389fdb35fc5d24d3a2acc67e393e1e87d66 Mon Sep 17 00:00:00 2001 From: Circle Ci Date: Fri, 12 Jul 2024 09:56:42 +0000 Subject: [PATCH] doc updates [skip ci] --- dev/.buildinfo | 2 +- .../auto_examples_python.zip | Bin 100022 -> 100022 bytes .../auto_examples_jupyter.zip | Bin 154541 -> 154541 bytes dev/_modules/index.html | 8 +- dev/_modules/mne_bids/copyfiles.html | 8 +- dev/_modules/mne_bids/dig.html | 10 +- dev/_modules/mne_bids/inspect.html | 8 +- dev/_modules/mne_bids/path.html | 8 +- 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 | 10 +- 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 | 919 +----------------- dev/auto_examples/convert_empty_room.html | 10 +- dev/auto_examples/convert_group_studies.html | 16 +- dev/auto_examples/convert_ieeg_to_bids.html | 186 +--- 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 | 21 +- dev/auto_examples/create_bids_folder.html | 10 +- dev/auto_examples/mark_bad_channels.html | 10 +- dev/auto_examples/read_bids_datasets.html | 483 +-------- .../rename_brainvision_files.html | 10 +- dev/auto_examples/sg_execution_times.html | 60 +- dev/auto_examples/update_bids_datasets.html | 165 +--- dev/contribute.html | 8 +- dev/generated/cli.html | 8 +- dev/generated/mne_bids.BIDSPath.html | 8 +- 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 | 8 +- .../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 | 8 +- dev/genindex.html | 8 +- dev/index.html | 8 +- dev/install.html | 8 +- dev/objects.inv | Bin 3758 -> 3758 bytes dev/py-modindex.html | 8 +- dev/search.html | 8 +- dev/searchindex.js | 2 +- dev/sg_execution_times.html | 60 +- dev/use.html | 8 +- dev/whats_new.html | 8 +- dev/whats_new_previous_releases.html | 8 +- 78 files changed, 445 insertions(+), 2111 deletions(-) diff --git a/dev/.buildinfo b/dev/.buildinfo index f4955a565..890261f1b 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: f304eda2a80f76f9f9a22b252adbfb46 +config: c2ef4344a071e605aefd65f27694da40 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/dev/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip b/dev/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip index 5db7283f878d37d48b28311c2c5fdac5c49b14f7..4e99a6ef3f8a8914b03e044adde9b5caedec4bb0 100644 GIT binary patch delta 270 zcmdni%eJkTjW@uXnMH&F1U~z{*~oiRmieyVo6R?6=V&wE0WvB)i}{%^0~zlkvgE)b z(dGLUn6CmwWM>#kf)xjDwBTbt4;1Oy|4*73Xw2r`+dAxE#-2x-63m}~A}@Z$^D}?& zd$Zk(i*ZUINN)SXXvWk0%s+vw_1TO*;vli<|C$)>L1s>OXl8Tw9po*uqFuH*pF#TQ&Pz}f&#a1XIrIpbP&-W1=V&u`0T~sZ#r(_$K*qa>EIDQi zAS1ebzXG!nkRdz6P!g;-aH9nuGb>P}Xa7HG=AA%B?`<7+Fk{anO$p{5K#>=};`y1E zx4qu(#l<)!5G1$#VKn1ue&!26*7|HlA8}@&{nP(7G1`O7obJ%f=nQhe^fnL!=z!^G zni(BH4w%m0!srNc!1Ul2sN$(DjBX$YOuyFxR0A}7x?(GokP0HEx3lK=n! diff --git a/dev/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip b/dev/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip index 84befc23178220bc9df38fce810243141a0d02fc..e419b839a2394078619264f8839cd8048c492df8 100644 GIT binary patch delta 275 zcmZ3xopbGWPTl}-W)=|!5cui$W+ShL7V`(cH=8ZA=GZac1v0K@)Jrp81u`OAm<^fl z02%RHe?S;f&zGrz)NE(wV|*{nd>P34s>pcGfcZ0!bu5T6ln>03OJv-o4QAc$VLU9y z{0S(#a5W=GCRl8Z2vfE+GtlboQU*-x)IqH2r^A_?K(3fB5W(aIvSE58hyirP^hFU& z&LCGze-Xjt0%qt(0u_VQlteOlf*djZKqOEN&<)esqM!_)C?-p=NC!v+=z!_xqL^I4 PB4W`%2FTL5XeNIEvrcv* delta 275 zcmZ3xopbGWPTl}-W)=|!5V+9xdLyrf7W4A9*PAW0=GZY$12V2>)JroP0U41k%!bTe zKt}x5ABM~pKt|N_WojTb+nMo Z2TVT~#pDXIf4W#SkO8!QdR#P - Overview: module code — MNE-BIDS 0.16.0.dev8+g313fe101 documentation + Overview: module code — MNE-BIDS 0.16.0.dev9+gf4f903af documentation @@ -40,7 +40,7 @@ - + @@ -147,7 +147,7 @@ -

MNE-BIDS 0.16.0.dev8+g313fe101 documentation

+

MNE-BIDS 0.16.0.dev9+gf4f903af documentation

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

All modules for which code is available

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

diff --git a/dev/_modules/mne_bids/copyfiles.html b/dev/_modules/mne_bids/copyfiles.html index 52639a275..f10e3a5be 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.dev8+g313fe101 documentation + mne_bids.copyfiles — MNE-BIDS 0.16.0.dev9+gf4f903af documentation @@ -40,7 +40,7 @@ - + @@ -147,7 +147,7 @@ -

MNE-BIDS 0.16.0.dev8+g313fe101 documentation

+

MNE-BIDS 0.16.0.dev9+gf4f903af documentation

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

Source code for mne_bids.copyfiles

 
   

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

     
   

diff --git a/dev/_modules/mne_bids/dig.html b/dev/_modules/mne_bids/dig.html
index c490d4066..6cd17ab8f 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.dev8+g313fe101 documentation
+    mne_bids.dig — MNE-BIDS 0.16.0.dev9+gf4f903af documentation
   
   
   
@@ -40,7 +40,7 @@
 
   
 
-    
+    
     
     
     
@@ -147,7 +147,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev8+g313fe101 documentation

+    
MNE-BIDS 0.16.0.dev9+gf4f903af documentation
@@ -850,7 +850,7 @@

Source code for mne_bids.dig

         hpi = {d["ident"]: d for d in dig if d["kind"] == FIFF.FIFFV_POINT_HPI}
         if hpi:
             for ident in hpi.keys():
-                coords["coil%d" % ident] = hpi[ident]["r"].tolist()
+                coords[f"coil{ident:d}"] = hpi[ident]["r"].tolist()
 
         fid_json = {
             "MEGCoordinateSystem": sensor_coord_system,
@@ -1357,7 +1357,7 @@ 
Source code for mne_bids.dig
 
   

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

     
   

diff --git a/dev/_modules/mne_bids/inspect.html b/dev/_modules/mne_bids/inspect.html
index 6a9fc0c82..10eb25cf3 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.dev8+g313fe101 documentation
+    mne_bids.inspect — MNE-BIDS 0.16.0.dev9+gf4f903af documentation
   
   
   
@@ -40,7 +40,7 @@
 
   
 
-    
+    
     
     
     
@@ -147,7 +147,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev8+g313fe101 documentation

+    
MNE-BIDS 0.16.0.dev9+gf4f903af documentation

   
 

     
@@ -1012,7 +1012,7 @@ 
Source code for mne_bids.inspect
 
   

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

     
   

diff --git a/dev/_modules/mne_bids/path.html b/dev/_modules/mne_bids/path.html
index 7ec0e9754..8dd9aa82d 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.dev8+g313fe101 documentation
+    mne_bids.path — MNE-BIDS 0.16.0.dev9+gf4f903af documentation
   
   
   
@@ -40,7 +40,7 @@
 
   
 
-    
+    
     
     
     
@@ -147,7 +147,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev8+g313fe101 documentation

+    
MNE-BIDS 0.16.0.dev9+gf4f903af documentation

   
 

     
@@ -3094,7 +3094,7 @@ 
Source code for mne_bids.path
 
   

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

     
   

diff --git a/dev/_modules/mne_bids/read.html b/dev/_modules/mne_bids/read.html
index d93ffe6dd..7dedec388 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.dev8+g313fe101 documentation
+    mne_bids.read — MNE-BIDS 0.16.0.dev9+gf4f903af documentation
   
   
   
@@ -40,7 +40,7 @@
 
   
 
-    
+    
     
     
     
@@ -147,7 +147,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev8+g313fe101 documentation

+    
MNE-BIDS 0.16.0.dev9+gf4f903af documentation

   
 

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

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

     
   

diff --git a/dev/_modules/mne_bids/report/_report.html b/dev/_modules/mne_bids/report/_report.html
index dc6e369fd..e4b97bd21 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.dev8+g313fe101 documentation
+    mne_bids.report._report — MNE-BIDS 0.16.0.dev9+gf4f903af documentation
   
   
   
@@ -40,7 +40,7 @@
 
   
 
-    
+    
     
     
     
@@ -147,7 +147,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev8+g313fe101 documentation

+    
MNE-BIDS 0.16.0.dev9+gf4f903af documentation

   
 

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

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

     
   

diff --git a/dev/_modules/mne_bids/sidecar_updates.html b/dev/_modules/mne_bids/sidecar_updates.html
index 72790985e..a3c14de66 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.dev8+g313fe101 documentation
+    mne_bids.sidecar_updates — MNE-BIDS 0.16.0.dev9+gf4f903af documentation
   
   
   
@@ -40,7 +40,7 @@
 
   
 
-    
+    
     
     
     
@@ -147,7 +147,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev8+g313fe101 documentation

+    
MNE-BIDS 0.16.0.dev9+gf4f903af documentation

   
 

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

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

     
   

diff --git a/dev/_modules/mne_bids/stats.html b/dev/_modules/mne_bids/stats.html
index c92d87d17..e32698b9b 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.dev8+g313fe101 documentation
+    mne_bids.stats — MNE-BIDS 0.16.0.dev9+gf4f903af documentation
   
   
   
@@ -40,7 +40,7 @@
 
   
 
-    
+    
     
     
     
@@ -147,7 +147,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev8+g313fe101 documentation

+    
MNE-BIDS 0.16.0.dev9+gf4f903af documentation

   
 

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

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

     
   

diff --git a/dev/_modules/mne_bids/utils.html b/dev/_modules/mne_bids/utils.html
index 6dba3d1a6..b748c8b69 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.dev8+g313fe101 documentation
+    mne_bids.utils — MNE-BIDS 0.16.0.dev9+gf4f903af documentation
   
   
   
@@ -40,7 +40,7 @@
 
   
 
-    
+    
     
     
     
@@ -147,7 +147,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev8+g313fe101 documentation

+    
MNE-BIDS 0.16.0.dev9+gf4f903af documentation

   
 

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

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

     
   

diff --git a/dev/_modules/mne_bids/write.html b/dev/_modules/mne_bids/write.html
index cb0766ad9..05fe37d31 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.dev8+g313fe101 documentation
+    mne_bids.write — MNE-BIDS 0.16.0.dev9+gf4f903af documentation
   
   
   
@@ -40,7 +40,7 @@
 
   
 
-    
+    
     
     
     
@@ -147,7 +147,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev8+g313fe101 documentation

+    
MNE-BIDS 0.16.0.dev9+gf4f903af documentation

   
 

     
@@ -2151,7 +2151,7 @@ 
Source code for mne_bids.write
 
     """
     if not isinstance(raw, BaseRaw):
-        raise ValueError("raw_file must be an instance of BaseRaw, got %s" % type(raw))
+        raise ValueError(f"raw_file must be an instance of BaseRaw, got {type(raw)}")
 
     if raw.preload is not False and not allow_preload:
         raise ValueError(
@@ -3723,7 +3723,7 @@ 
Source code for mne_bids.write
 
   

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

     
   

diff --git a/dev/_static/documentation_options.js b/dev/_static/documentation_options.js
index 3765a8246..da3f2f92b 100644
--- a/dev/_static/documentation_options.js
+++ b/dev/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.16.0.dev8+g313fe101',
+    VERSION: '0.16.0.dev9+gf4f903af',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',
diff --git a/dev/api.html b/dev/api.html
index 7ef9a75a1..cf7f6f7ba 100644
--- a/dev/api.html
+++ b/dev/api.html
@@ -8,7 +8,7 @@
     
     
 
-    API Documentation — MNE-BIDS 0.16.0.dev8+g313fe101 documentation
+    API Documentation — MNE-BIDS 0.16.0.dev9+gf4f903af documentation
   
   
   
@@ -41,7 +41,7 @@
 
   
 
-    
+    
     
     
     
@@ -150,7 +150,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev8+g313fe101 documentation

+    
MNE-BIDS 0.16.0.dev9+gf4f903af documentation

   
 

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

     
   

diff --git a/dev/authors.html b/dev/authors.html
index 0ddd07b50..49856e736 100644
--- a/dev/authors.html
+++ b/dev/authors.html
@@ -8,7 +8,7 @@
     
     
 
-    <no title> — MNE-BIDS 0.16.0.dev8+g313fe101 documentation
+    <no title> — MNE-BIDS 0.16.0.dev9+gf4f903af documentation
   
   
   
@@ -41,7 +41,7 @@
 
   
 
-    
+    
     
     
     
@@ -148,7 +148,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev8+g313fe101 documentation

+    
MNE-BIDS 0.16.0.dev9+gf4f903af documentation

   
 

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

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

     
   

diff --git a/dev/auto_examples/anonymize_dataset.html b/dev/auto_examples/anonymize_dataset.html
index 7e5ea97a8..a49142ed4 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.dev8+g313fe101 documentation
+    13. Anonymizing a BIDS dataset — MNE-BIDS 0.16.0.dev9+gf4f903af documentation
   
   
   
@@ -41,7 +41,7 @@
 
   
 
-    
+    
     
     
     
@@ -151,7 +151,7 @@
   
   
   
-    
MNE-BIDS 0.16.0.dev8+g313fe101 documentation

+    
MNE-BIDS 0.16.0.dev9+gf4f903af 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.579 seconds)

+

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