Version RunDescriber, and 5->6 DB upgrade, also reorg run descriptions module structure

.travis.yml

@@ -51,6 +51,7 @@ script:
       python generate_version_3.py
       python generate_version_4a.py
       python generate_version_4.py
+      python generate_version_5.py
       cd $TRAVIS_BUILD_DIR
       pip uninstall -y qcodes
       pip install .

azure-pipelines.yml

@@ -65,6 +65,7 @@ jobs:
           python generate_version_3.py
           python generate_version_4a.py
           python generate_version_4.py
+          python generate_version_5.py
         displayName: "Generate db fixtures"
         condition: succeededOrFailed()
       - script: |

docs/examples/DataSet/Benchmarking.ipynb

@@ -18,8 +18,7 @@
     "%matplotlib notebook\n",
     "import matplotlib.pyplot as plt\n",
     "import qcodes as qc\n",
-    "from qcodes import ParamSpec, new_data_set, new_experiment\n",
-    "from qcodes.dataset.database import initialise_database\n",
+    "from qcodes import ParamSpec, new_data_set, new_experiment, initialise_database\n",
     "import numpy as np"
    ]
   },

docs/examples/DataSet/Dataset Context Manager.ipynb

@@ -32,28 +32,18 @@
    ],
    "source": [
     "%matplotlib notebook\n",
-    "from collections import OrderedDict\n",
-    "from typing import Dict, Callable\n",
-    "from inspect import signature\n",
     "import numpy.random as rd\n",
     "import matplotlib.pyplot as plt\n",
-    "import json\n",
     "from functools import partial\n",
     "import numpy as np\n",
     "\n",
     "from time import sleep, monotonic\n",
     "\n",
     "import qcodes as qc\n",
-    "from qcodes import Station\n",
-    "from qcodes.dataset.experiment_container import (Experiment,\n",
-    "                                                 load_last_experiment,\n",
-    "                                                 load_or_create_experiment)\n",
-    "from qcodes.dataset.database import initialise_database\n",
+    "from qcodes import Station, load_or_create_experiment, \\\n",
+    "    initialise_database, Measurement\n",
     "from qcodes.tests.instrument_mocks import DummyInstrument\n",
-    "from qcodes.dataset.param_spec import ParamSpec\n",
-    "from qcodes.dataset.measurements import Measurement\n",
     "from qcodes.dataset.plotting import plot_by_id\n",
-    "from qcodes.dataset.data_export import get_shaped_data_by_runid\n",
     "\n",
     "qc.logger.start_all_logging()"
    ]

docs/examples/DataSet/Offline Plotting Tutorial.ipynb

@@ -25,9 +25,8 @@
     "from typing import List, Dict, Tuple, Any\n",
     "import matplotlib.pyplot as plt\n",
     "import qcodes as qc\n",
-    "from qcodes import Parameter, new_experiment, Measurement\n",
-    "from qcodes.dataset.plotting import plot_by_id\n",
-    "from qcodes.dataset.database import initialise_database"
+    "from qcodes import Parameter, new_experiment, Measurement, initialise_database\n",
+    "from qcodes.dataset.plotting import plot_by_id"
    ]
   },
   {

docs/examples/DataSet/Offline plotting with categorical data.ipynb

@@ -18,11 +18,8 @@
     "%matplotlib notebook\n",
     "import numpy as np\n",
     "\n",
-    "from qcodes import Parameter\n",
-    "from qcodes.dataset.plotting import plot_by_id, get_data_by_id\n",
-    "from qcodes.dataset.measurements import Measurement\n",
-    "from qcodes.dataset.database import initialise_database\n",
-    "from qcodes.dataset.experiment_container import new_experiment"
+    "from qcodes import Parameter, Measurement, initialise_database, new_experiment\n",
+    "from qcodes.dataset.plotting import plot_by_id"
    ]
   },
   {

docs/examples/DataSet/Paramtypes explained.ipynb

@@ -22,17 +22,15 @@
    "outputs": [],
    "source": [
     "import os\n",
+    "import time\n",
     "\n",
     "import numpy as np\n",
     "\n",
+    "from qcodes import initialise_or_create_database_at, \\\n",
+    "    new_experiment, Measurement, load_by_id\n",
     "from qcodes.instrument.parameter import ArrayParameter, Parameter\n",
-    "from qcodes.dataset.database import initialise_or_create_database_at\n",
-    "from qcodes.dataset.experiment_container import new_experiment\n",
-    "from qcodes.dataset.measurements import Measurement\n",
-    "from qcodes.dataset.data_set import load_by_id\n",
     "from qcodes.dataset.data_export import get_data_by_id\n",
-    "from qcodes.tests.instrument_mocks import DummyInstrument\n",
-    "import time"
+    "from qcodes.tests.instrument_mocks import DummyInstrument"
    ]
   },
   {

docs/examples/DataSet/Pedestrian example of subscribing to a DataSet.ipynb

@@ -37,15 +37,12 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": 2,
    "metadata": {},
    "outputs": [],
    "source": [
-    "from qcodes.dataset.database import initialise_database\n",
-    "from qcodes.dataset.data_set import new_data_set, ParamSpec\n",
-    "from qcodes.dataset.experiment_container import new_experiment\n",
-    "import logging\n",
-    "import warnings\n",
+    "from qcodes import initialise_database, new_experiment, \\\n",
+    "    new_data_set, ParamSpec\n",
     "import numpy as np\n",
     "from time import sleep"
    ]

docs/examples/DataSet/The-Experiment-Container.ipynb

@@ -16,7 +16,7 @@
    "outputs": [],
    "source": [
     "import qcodes as qc\n",
-    "from qcodes.dataset.database import initialise_database"
+    "from qcodes import initialise_database"
    ]
   },
   {
@@ -94,74 +94,7 @@
    "cell_type": "code",
    "execution_count": 4,
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "CREATE  TABLE IF NOT EXISTS experiments (\n",
-      "    -- this will autoncrement by default if\n",
-      "    -- no value is specified on insert\n",
-      "    exp_id INTEGER PRIMARY KEY,\n",
-      "    name TEXT,\n",
-      "    sample_name TEXT,\n",
-      "    start_time INTEGER,\n",
-      "    end_time INTEGER,\n",
-      "    -- this is the last counter registered\n",
-      "    -- 1 based\n",
-      "    run_counter INTEGER,\n",
-      "    -- this is the formatter strin used to cosntruct\n",
-      "    -- the run name\n",
-      "    format_string TEXT\n",
-      "-- TODO: maybe I had a good reason for this doulbe primary key\n",
-      "--    PRIMARY KEY (exp_id, start_time, sample_name)\n",
-      ");\n",
-      "\n",
-      "CREATE TABLE IF NOT EXISTS runs (\n",
-      "    -- this will autoincrement by default if\n",
-      "    -- no value is specified on insert\n",
-      "    run_id INTEGER PRIMARY KEY,\n",
-      "    exp_id INTEGER,\n",
-      "    -- friendly name for the run\n",
-      "    name TEXT,\n",
-      "    -- the name of the table which stores\n",
-      "    -- the actual results\n",
-      "    result_table_name TEXT,\n",
-      "    -- this is the run counter in its experiment 0 based\n",
-      "    result_counter INTEGER,\n",
-      "    ---\n",
-      "    run_timestamp INTEGER,\n",
-      "    completed_timestamp INTEGER,\n",
-      "    is_completed BOOL,\n",
-      "    parameters TEXT,\n",
-      "    -- metadata fields are added dynamically\n",
-      "    FOREIGN KEY(exp_id)\n",
-      "    REFERENCES\n",
-      "        experiments(exp_id)\n",
-      ");\n",
-      "\n",
-      "CREATE TABLE IF NOT EXISTS layouts (\n",
-      "    layout_id INTEGER PRIMARY KEY,\n",
-      "    run_id INTEGER,\n",
-      "    -- name matching column name in result table\n",
-      "    parameter TEXT,\n",
-      "    label TEXT,\n",
-      "    unit TEXT,\n",
-      "    inferred_from TEXT,\n",
-      "    FOREIGN KEY(run_id)\n",
-      "    REFERENCES\n",
-      "        runs(run_id)\n",
-      ");\n",
-      "\n",
-      "CREATE TABLE IF NOT EXISTS dependencies (\n",
-      "    dependent INTEGER,\n",
-      "    independent INTEGER,\n",
-      "    axis_num INTEGER\n",
-      ");\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "# point the config system to the new location\n",
     "configuration['core']['db_location'] = './exp_container_tutorial.db'\n",
@@ -189,7 +122,16 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 6,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from qcodes import experiments"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
    "metadata": {},
    "outputs": [
     {
@@ -198,13 +140,13 @@
        "[]"
       ]
      },
-     "execution_count": 5,
+     "execution_count": 7,
      "metadata": {},
      "output_type": "execute_result"
     }
    ],
    "source": [
-    "qc.dataset.experiment_container.experiments()"
+    "experiments()"
    ]
   },
   {
@@ -216,7 +158,16 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 8,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from qcodes import new_experiment"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 9,
    "metadata": {},
    "outputs": [
     {
@@ -226,20 +177,20 @@
        "---------------------------------------------------------"
       ]
      },
-     "execution_count": 6,
+     "execution_count": 9,
      "metadata": {},
      "output_type": "execute_result"
     }
    ],
    "source": [
-    "qc.dataset.experiment_container.new_experiment('first_exp', sample_name='old_sample')\n",
-    "qc.dataset.experiment_container.new_experiment('second_exp', sample_name='slightly_newer_sample')\n",
-    "qc.dataset.experiment_container.new_experiment('second_exp', sample_name='brand_new_sample')"
+    "new_experiment('first_exp', sample_name='old_sample')\n",
+    "new_experiment('second_exp', sample_name='slightly_newer_sample')\n",
+    "new_experiment('second_exp', sample_name='brand_new_sample')"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": 10,
    "metadata": {},
    "outputs": [
     {
@@ -253,13 +204,13 @@
        " ---------------------------------------------------------]"
       ]
      },
-     "execution_count": 7,
+     "execution_count": 10,
      "metadata": {},
      "output_type": "execute_result"
     }
    ],
    "source": [
-    "qc.dataset.experiment_container.experiments()"
+    "experiments()"
    ]
   },
   {
@@ -273,7 +224,16 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 8,
+   "execution_count": 11,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from qcodes import new_data_set"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 12,
    "metadata": {},
    "outputs": [
     {
@@ -283,18 +243,18 @@
        "-----------------------------------------"
       ]
      },
-     "execution_count": 8,
+     "execution_count": 12,
      "metadata": {},
      "output_type": "execute_result"
     }
    ],
    "source": [
-    "qc.dataset.data_set.new_data_set('a_good_run', exp_id=2)"
+    "new_data_set('a_good_run', exp_id=2)"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": 13,
    "metadata": {},
    "outputs": [
     {
@@ -304,13 +264,13 @@
        "-------------------------------------------"
       ]
      },
-     "execution_count": 9,
+     "execution_count": 13,
      "metadata": {},
      "output_type": "execute_result"
     }
    ],
    "source": [
-    "qc.dataset.data_set.new_data_set('a_nother_run', exp_id=2)"
+    "new_data_set('a_nother_run', exp_id=2)"
    ]
   },
   {
@@ -322,16 +282,25 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 10,
+   "execution_count": 14,
    "metadata": {},
    "outputs": [],
    "source": [
-    "exp_2 = qc.dataset.experiment_container.load_experiment(2)"
+    "from qcodes import load_experiment"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 11,
+   "execution_count": 15,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "exp_2 = load_experiment(2)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 16,
    "metadata": {},
    "outputs": [
     {
@@ -340,8 +309,8 @@
      "text": [
       "second_exp#slightly_newer_sample#2@./exp_container_tutorial.db\n",
       "--------------------------------------------------------------\n",
-      "1-a_good_run-1-None-0\n",
-      "2-a_nother_run-2-None-0\n"
+      "1-a_good_run-1--0\n",
+      "2-a_nother_run-2--0\n"
      ]
     }
    ],