6 Commits 3bcb4e027f ... 61e29e8972

Author SHA1 Message Date
  girish 61e29e8972 Add CODE OF CONDUCT 5 months ago
  girish 5fd27887cd Update README 5 months ago
  girish 10cd5c9305 Add tutorials to introduce users to resource usage 5 months ago
  girish 3bcb4e027f Add CODE OF CONDUCT 5 months ago
  girish 7daad9e30f Update README 5 months ago
  girish 0c4cf84b65 Add tutorials to introduce users to resource usage 5 months ago

+ 50 - 0
CODE_OF_CONDUCT.md

@@ -0,0 +1,50 @@
+# Data Use Terms
+
+CALM-Brain is distributed to the greater scientific community by the
+CBM-ADBS study under the following terms:
+
+1.  You agree not to attempt to establish the identity of or to make
+    contact with any of the included human participants. This
+    prohibition includes, but is not limited to, the use of facial
+    recognition and 3D facial rendering technologies.
+
+2.  You agree to acknowledge the use of the CALM-Brain resource and any
+    data derived from it in all public presentations of results or
+    algorithms that benefited from their use. This includes:
+
+    -   Acknowledgments: \"Data was provided \[in part\] by CALM-Brain
+        \[insert appropriate release version\]. Data in the CALM-Brain
+        resouce was collected by CBM-ADBS study."
+    -   Citation: Until a journal article is available for the resource,
+        please cite the below reference.
+
+    ``` text
+    Viswanath, B., Rao, N.P., Narayanaswamy, J.C. et al. Discovery biology
+    of neuropsychiatric syndromes (DBNS): a center for integrating clinical
+    medicine and basic science. BMC Psychiatry 18, 106 (2018). doi:
+    https://doi.org/10.1186/s12888-018-1674-2.
+    ```
+
+3.  You agree to provide the Center for Brain and Mind with information
+    about your use of the CALM-Brain resource upon request.
+
+4.  You acknowledge that failure to comply with these data use terms may
+    result in the termination of your right to access and use the
+    CALM-Brain resource.
+
+## Who Can Obtain Access?
+
+Anyone with a scientific usecase can request for access. The resource is
+divided into different zones and the access request should mention the
+zones of interest. Lower zones have a strict vetting process and require
+a detailed statement.
+
+-   Zone 1: Contains raw data collected. Access requests to this is not
+    possible.
+-   Zone 2: Contains pre-release data. Comes with compute resources to
+    perform local analysis via access to the server that hosts the data.
+-   Zone 3: Contains anonymized and stable release.
+-   Zone 4: Contains the resource index and is openly accessible. You
+    can try it out [here](https://calm-brain.ncbs.res.in/search/).
+
+All CALM-Brain data use is governed by these data use terms.

+ 0 - 58
CODE_OF_CONDUCT.rst

@@ -1,58 +0,0 @@
-Data Use Terms
-==============
-
-
-CALM-Brain is distributed to the greater scientific community by the
-CBM-ADBS study under the following terms:
-
-#. You agree not to attempt to establish the identity of or to make
-   contact with any of the included human participants. This
-   prohibition includes, but is not limited to, the use of facial
-   recognition and 3D facial rendering technologies.
-   
-#. You agree to acknowledge the use of the CALM-Brain resource and any
-   data derived from it in all public presentations of results or
-   algorithms that benefited from their use. This includes:
-   
-   * Acknowledgments: "Data was provided [in part] by CALM-Brain
-     [insert appropriate release version]. Data in the CALM-Brain
-     resouce was collected by CBM-ADBS study.”
-
-   * Citation: Until a journal article is available for the resource,
-     please cite the below reference.
-
-   .. code-block:: text
-		   
-		   Viswanath, B., Rao, N.P., Narayanaswamy, J.C. et al. Discovery biology
-		   of neuropsychiatric syndromes (DBNS): a center for integrating clinical
-		   medicine and basic science. BMC Psychiatry 18, 106 (2018). doi:
-		   https://doi.org/10.1186/s12888-018-1674-2.
-		    
-#. You agree to provide the Center for Brain and Mind with information
-   about your use of the CALM-Brain resource upon request.
-   
-#. You acknowledge that failure to comply with these data use terms
-   may result in the termination of your right to access and use the
-   CALM-Brain resource.
-   
-   
-Who Can Obtain Access?
-----------------------
-
-Anyone with a scientific usecase can request for access. The resource
-is divided into different zones and the access request should mention
-the zones of interest. Lower zones have a strict vetting process and
-require a detailed statement.
-
-* Zone 1: Contains raw data collected. Access requests to this is not
-  possible.
-
-* Zone 2: Contains pre-release data. Comes with compute resources to
-  perform local analysis via access to the server that hosts the data.
-
-* Zone 3: Contains anonymized and stable release.
-
-* Zone 4: Contains the resource index and is openly accessible. You
-  can try it out `here <https://www.calm-brain.ncbs.res.in/search/>`_.
-	
-All CALM-Brain data use is governed by these data use terms.

+ 2 - 2
tutorials/README.md

@@ -5,8 +5,8 @@ simple analysis and visualization using the CALM-Brain resource. The
 examples lack a narrative explanation but are well-commented with
 examples lack a narrative explanation but are well-commented with
 appropriate variable names to make the it self-explanatory. In case
 appropriate variable names to make the it self-explanatory. In case
 you haven't already, please checkout the [user
 you haven't already, please checkout the [user
-guide](/wiki/Home). These examples are a way to get familiar with
-using [almirah](https://girishmm.github.io/almirah/) and the
+guide](../../..//wiki/Home). These examples are a way to get familiar
+with using [almirah](https://girishmm.github.io/almirah/) and the
 CALM-Brain resource. The sole purpose of these tutorials is to
 CALM-Brain resource. The sole purpose of these tutorials is to
 acquaint the user with the components of the resource and not provide
 acquaint the user with the components of the resource and not provide
 data related insights.
 data related insights.

+ 12 - 15
tutorials/modality/importing-eyetrack-with-mne.md

@@ -47,20 +47,19 @@ raw
 <details open>
 <details open>
     <summary><strong>General</strong></summary>
     <summary><strong>General</strong></summary>
     <table class="table table-hover table-striped table-sm table-responsive small">
     <table class="table table-hover table-striped table-sm table-responsive small">
-        <tr>
-            <th>Measurement date</th>
-            <td>January 01, 2009  00:03:33 GMT</td>
-        </tr>
-        <tr>
-            <th>Experimenter</th>
-            <td>Unknown</td>
-        </tr>
-        <tr>
-            <th>Participant</th>
-            <td>Unknown</td>
-        </tr>
+	<tr>
+	    <th>Measurement date</th>
+	    <td>January 01, 2009  00:03:33 GMT</td>
+	</tr>
+	<tr>
+	    <th>Experimenter</th>
+	    <td>Unknown</td>
+	</tr>
+	<tr>
+	    <th>Participant</th>
+	    <td>Unknown</td>
+	</tr>
     </table>
     </table>
-    </summary>
 </details>
 </details>
 <details open>
 <details open>
     <summary><strong>Channels</strong></summary>
     <summary><strong>Channels</strong></summary>
@@ -86,7 +85,6 @@ raw
 	    <td>Not available</td>
 	    <td>Not available</td>
 	</tr>
 	</tr>
     </table>
     </table>
-    </summary>
 </details>
 </details>
 <details open>
 <details open>
     <summary><strong>Data</strong></summary>
     <summary><strong>Data</strong></summary>
@@ -112,7 +110,6 @@ raw
 	    <td>00:01:11 (HH:MM:SS)</td>
 	    <td>00:01:11 (HH:MM:SS)</td>
 	</tr>
 	</tr>
     </table>
     </table>
-    </summary>
 </details>
 </details>
 
 
 ```python
 ```python

+ 12 - 15
tutorials/modality/processing-eeg-with-mne.md

@@ -56,20 +56,19 @@ raw.info
 <details open>
 <details open>
     <summary><strong>General</strong></summary>
     <summary><strong>General</strong></summary>
     <table class="table table-hover table-striped table-sm table-responsive small">
     <table class="table table-hover table-striped table-sm table-responsive small">
-        <tr>
-            <th>Measurement date</th>
-            <td>Unknown</td>
-        </tr>
-        <tr>
-            <th>Experimenter</th>
-            <td>Unknown</td>
-        </tr>
-        <tr>
-            <th>Participant</th>
-            <td>Unknown</td>
-        </tr>
+	<tr>
+	    <th>Measurement date</th>
+	    <td>Unknown</td>
+	</tr>
+	<tr>
+	    <th>Experimenter</th>
+	    <td>Unknown</td>
+	</tr>
+	<tr>
+	    <th>Participant</th>
+	    <td>Unknown</td>
+	</tr>
     </table>
     </table>
-    </summary>
 </details>
 </details>
 <details open>
 <details open>
     <summary><strong>Channels</strong></summary>
     <summary><strong>Channels</strong></summary>
@@ -95,7 +94,6 @@ raw.info
 	    <td>Not available</td>
 	    <td>Not available</td>
 	</tr>
 	</tr>
     </table>
     </table>
-    </summary>
 </details>
 </details>
 <details open>
 <details open>
     <summary><strong>Data</strong></summary>
     <summary><strong>Data</strong></summary>
@@ -113,7 +111,6 @@ raw.info
 	    <td>500.00 Hz</td>
 	    <td>500.00 Hz</td>
 	</tr>
 	</tr>
     </table>
     </table>
-    </summary>
 </details>
 </details>
 
 
 # Preprocessing
 # Preprocessing