Merge pull request #457 from int-brain-lab/feature/update-docs

Feature/update docs

docs/source/frequent_issues.md

@@ -0,0 +1,13 @@
+# Frequent Issues
+
+## Sound
+
+- Is everything wired and set up according to [the manual](https://doi.org/10.6084/m9.figshare.11634732.v6)?
+- Is `hardware_settings.yaml` set up correctly? Valid options for sound `OUTPUT` are:
+ - `harp`,
+ - `xonar` or
+ - `sysdefault`.
+
+ Make sure that this value matches the actual soundcard used on your rig.
+
+- Double-check all wiring for loose connections. 

docs/source/index.rst

@@ -11,6 +11,7 @@ Welcome to iblrig's documentation!
  :caption: Contents:
 
  usage
+ frequent_issues
  installation
  description_file
  developer_guide

docs/source/usage.md

@@ -1,13 +1,38 @@
 # Using IBLRIG
 
 ## Run a task
-### Through the gaphical user interface
+### Through the graphical user interface
 
-To run a task using the graphical user interface, open a terminal and type in the `iblrig command`
+To run a task using the graphical user interface, open a terminal and type in the following:
 
  C:\iblrigv8\venv\scripts\Activate.ps1
  iblrig
 
+The *IBL Rig Wizard* GUI window will pop open:![gui.png](gui.png)
+
+1. Enter your Alyx username & click connect
+
+ This will populate the GUI's fields with the entries relevant to your lab.
+
+2. Select the desired values.
+
+ Use the *Filter* field to quickly narrow down the displayed subjects.
+
+3. Hit *Start* and off you go.
+
+
+There are some additional controls in the *Flow* section:
+
+- When checking *Append* before pressing *Start*, the task will be joined to the previous task - resulting in chained tasks.
+
+- The *Flush* button will toggle the valve for cleaning purposes.
+
+
+
+
+
+
+
 ### Command Line
 To run a task using command line, open a terminal and activate the environment and set current directory.
 

iblrig/gui/wizard.py

@@ -216,6 +216,7 @@ def flush(self):
 
 def main():
  app = QtWidgets.QApplication([])
+ app.setStyle("Fusion")
  w = RigWizard()
  w.show()
  app.exec_()

iblrig/gui/wizard.ui

@@ -8,6 +8,7 @@
  <y>0</y>
  <width>698</width>
  <height>432</height>
+ <height>450</height>
  </rect>
  </property>
  <property name="windowTitle">
@@ -144,38 +145,7 @@
  <string>Flow</string>
  </property>
  <layout class="QGridLayout" name="gridLayout">
- <item row="0" column="0">
- <widget class="QLabel" name="uiLabelDevices">
- <property name="text">
- <string># Devices</string>
- </property>
- </widget>
- </item>
- <item row="0" column="2">
- <widget class="QCheckBox" name="uiCheckAppend">
- <property name="toolTip">
- <string>Append to existing session for the same day</string>
- </property>
- <property name="text">
- <string>Append</string>
- </property>
- </widget>
- </item>
  <item row="2" column="0">
- <widget class="QSpinBox" name="uiSpinDevices">
- <property name="toolTip">
- <string>Number of additional computers (video +1, ephys +1, photometry +1)</string>
- </property>
- </widget>
- </item>
- <item row="2" column="2">
- <widget class="QPushButton" name="uiPushStart">
- <property name="text">
- <string>Start</string>
- </property>
- </widget>
- </item>
- <item row="2" column="1">
  <widget class="QPushButton" name="uiPushFlush">
  <property name="enabled">
  <bool>true</bool>
@@ -188,7 +158,14 @@
  </property>
  </widget>
  </item>
- <item row="3" column="1">
+ <item row="2" column="1">
+ <widget class="QPushButton" name="uiPushStart">
+ <property name="text">
+ <string>Start</string>
+ </property>
+ </widget>
+ </item>
+ <item row="3" column="0">
  <spacer name="verticalSpacer_4">
  <property name="orientation">
  <enum>Qt::Vertical</enum>
@@ -201,6 +178,16 @@
  </property>
  </spacer>
  </item>
+ <item row="3" column="1">
+ <widget class="QCheckBox" name="uiCheckAppend">
+ <property name="toolTip">
+ <string>Append to existing session for the same day</string>
+ </property>
+ <property name="text">
+ <string>Append</string>
+ </property>
+ </widget>
+ </item>
  </layout>
  </widget>
  </item>