Merge pull request #174 from ContextLab/subtraction_work

adding auto build stuff
ContextLab · Jul 27, 2018 · 718ef27 · 718ef27
2 parents 9a69640 + 8e026c4
commit 718ef27
Show file tree

Hide file tree

Showing 8 changed files with 25 additions and 17 deletions.
diff --git a/docs/auto_examples/auto_examples_jupyter.zip b/docs/auto_examples/auto_examples_jupyter.zip
diff --git a/docs/auto_examples/auto_examples_python.zip b/docs/auto_examples/auto_examples_python.zip
diff --git a/docs/tutorial/simulate_objects.rst b/docs/tutorial/simulate_objects.rst
@@ -61,33 +61,33 @@ To begin, we can either simulate locations:
       <tbody>
         <tr>
           <th>0</th>
-          <td>-49</td>
-          <td>11</td>
-          <td>32</td>
+          <td>-17</td>
+          <td>2</td>
+          <td>4</td>
         </tr>
         <tr>
           <th>1</th>
-          <td>-29</td>
-          <td>44</td>
-          <td>34</td>
+          <td>-14</td>
+          <td>9</td>
+          <td>-1</td>
         </tr>
         <tr>
           <th>2</th>
-          <td>-3</td>
-          <td>32</td>
-          <td>14</td>
+          <td>-7</td>
+          <td>-35</td>
+          <td>-9</td>
         </tr>
         <tr>
           <th>3</th>
-          <td>-1</td>
-          <td>8</td>
-          <td>21</td>
+          <td>-2</td>
+          <td>10</td>
+          <td>3</td>
         </tr>
         <tr>
           <th>4</th>
-          <td>13</td>
-          <td>30</td>
-          <td>-16</td>
+          <td>-2</td>
+          <td>23</td>
+          <td>44</td>
         </tr>
       </tbody>
     </table>

diff --git a/docs/tutorial/simulate_objects_files/simulate_objects_12_0.png b/docs/tutorial/simulate_objects_files/simulate_objects_12_0.png
diff --git a/docs/tutorial/simulate_objects_files/simulate_objects_13_0.png b/docs/tutorial/simulate_objects_files/simulate_objects_13_0.png
diff --git a/supereeg/brain.py b/supereeg/brain.py
@@ -237,6 +237,9 @@ def __next__(self):
         return s
 
     def next(self):
+        """
+        Return next sample from Brain object (wrapper for self.__next__)
+        """
         return self.__next__()
 
     def update_filter_inds(self):

diff --git a/supereeg/nifti.py b/supereeg/nifti.py
@@ -213,10 +213,15 @@ def make_gif(self, gifpath, index=range(0, 10), name=None, **kwargs):
 
 
     def get_locs(self):
+        """
+        Return locations of voxels
+        """
         bo = Brain(self)
         return bo.get_locs()
 
 
     def save(self, filepath):
-
+        """
+        Save file to disk
+        """
         self.to_filename(filepath)
diff --git a/supereeg/simulate.py b/supereeg/simulate.py
@@ -137,7 +137,7 @@ def simulate_model_data(n_samples=1000, n_elecs=170, locs=None, sample_locs=None
         Noise added to simulation
 
     set_random_seed : bool or int
-        Default False.  If True, set random seed to 123.  If int, set random seed to value.
+        Default False (choose a random seed).  If True, set random seed to 123.  If int, set random seed to the specified value.
 
     Returns
     ----------