Merge pull request #1560 from Dominik-Vogel/station_configurator

Extend QCoDeS-Station to be configurable through yaml file

docs/community/objects.rst

@@ -36,9 +36,13 @@ to use. Normal text shows the container includes and uses of this object.
 Station
 -------
 
-Read more about :ref:`station_api`.
+A convenient container for instruments, parameters, and more.
+
+More information:
+
+- `Station example notebook <../examples/Station.ipynb>`_
+- :ref:`station_api` API reference
 
-.. todo:: is this how we want it ? or like the one below ?
 
 .. _instrument :
 

docs/examples/Configuring_QCoDeS.ipynb

@@ -49,7 +49,7 @@
        "  'defaultcolormap': 'hot'},\n",
        " 'user': {'scriptfolder': 'c:\\\\Users\\\\jenielse\\\\myscripts\\\\',\n",
        "  'mainfolder': 'c:\\\\Users\\\\jenielse\\\\mymainfolder\\\\'},\n",
-       " 'station_configurator': {'enable_forced_reconnect': False,\n",
+       " 'station': {'enable_forced_reconnect': False,\n",
        "  'default_folder': 'c:\\\\Users\\\\jenielse\\\\mymainfolder\\\\',\n",
        "  'default_file': 'instrument_config.yaml'}}"
       ]
@@ -82,7 +82,7 @@
        "  'pyqtmaxplots': 100,\n",
        "  'defaultcolormap': 'hot'},\n",
        " 'user': {'scriptfolder': '.', 'mainfolder': '.'},\n",
-       " 'station_configurator': {'enable_forced_reconnect': False,\n",
+       " 'station': {'enable_forced_reconnect': False,\n",
        "  'default_folder': '.',\n",
        "  'default_file': 'instrument_config.yml'}}"
       ]
@@ -235,7 +235,7 @@
        "  'defaultcolormap': 'hot'},\n",
        " 'user': {'scriptfolder': 'c:\\\\Users\\\\jenielse\\\\myscripts\\\\',\n",
        "  'mainfolder': 'c:\\\\Users\\\\jenielse\\\\mymainfolder\\\\'},\n",
-       " 'station_configurator': {'enable_forced_reconnect': False,\n",
+       " 'station': {'enable_forced_reconnect': False,\n",
        "  'default_folder': 'c:\\\\Users\\\\jenielse\\\\mymainfolder\\\\',\n",
        "  'default_file': 'instrument_config.yaml'}}"
       ]

docs/examples/DataSet/Dataset Context Manager.ipynb

@@ -6706,7 +6706,9 @@
     }
    ],
    "source": [
-    "datasaver.dataset.get_data_as_pandas_dataframe()['dmm_v1'][0:10].to_xarray()"
+    "#df_sliced = datasaver.dataset.get_data_as_pandas_dataframe()['dmm_v1'].sort_index()[0:10]\n",
+    "#df_sliced.index = df_sliced.index.remove_unused_levels()\n",
+    "#df_sliced.to_xarray()"
    ]
   },
   {

docs/examples/DataSet/Working with snapshots.ipynb

@@ -7,10 +7,11 @@
     "# Working with snapshots\n",
     "\n",
     "Here, the following topics are going to be covered:\n",
-    "* What is a snapshot\n",
-    "* How to create it\n",
-    "* How it is saved next to the measurement data\n",
-    "* How to extract snapshot from the dataset"
+    "\n",
+    "- What is a snapshot\n",
+    "- How to create it\n",
+    "- How it is saved next to the measurement data\n",
+    "- How to extract snapshot from the dataset"
    ]
   },
   {
@@ -272,9 +273,9 @@
     "\n",
     "Experimental setups are large, and instruments tend to be quite complex in that they comprise many parameters and other stateful parts. It would be very time-consuming for the user to manually go through every instrument and parameter, and collect the snapshot data.\n",
     "\n",
-    "Here is where the concept of station comes into play. Instruments, parameters, and other submodules can be added to a station. In turn, the station has its `snapshot` method that allows to create a collective, single snapshot of all the instruments, parameters, and submodules.\n",
+    "Here is where the concept of station comes into play. Instruments, parameters, and other submodules can be added to a [Station object](../Station.ipynb) ([nbviewer.jupyter.org link](https://nbviewer.jupyter.org/github/QCoDeS/Qcodes/tree/master/docs/examples/Station.ipynb)). In turn, the station has its `snapshot` method that allows to create a collective, single snapshot of all the instruments, parameters, and submodules.\n",
     "\n",
-    "Note that in this article the focus is on the snapshot feature of the QCoDeS `Station`, while it has some other (mostly legacy) features."
+    "Note that in this article the focus is on the snapshot feature of the QCoDeS `Station`, while it has some other features (also some legacy once)."
    ]
   },
   {
@@ -799,7 +800,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python [default]",
    "language": "python",
    "name": "python3"
   },
@@ -813,7 +814,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.6.6"
+   "version": "3.6.8"
   },
   "toc": {
    "base_numbering": 1,