MicroDrop step routes table format

README.md

This repo includes a notebook to show the format of routes table/dataframe expected by the MicroDrop droplet-planning-plugin.

MicroDrop - routes table format.ipynb

{
 "cells": [
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {
    "ExecuteTime": {
     "end_time": "2019-09-04T17:19:21.437000Z",
     "start_time": "2019-09-04T17:19:21.431000Z"
    }
   },
   "outputs": [],
   "source": [
    "routes = [['electrode087', 'electrode053', 'electrode006', 'electrode007',\n",
    "           'electrode067'],\n",
    "          ['electrode009', 'electrode065', 'electrode066', 'electrode067']]"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {
    "ExecuteTime": {
     "end_time": "2019-09-04T17:19:21.473000Z",
     "start_time": "2019-09-04T17:19:21.443000Z"
    }
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "{'columns': ['route_i', 'transition_i', 'electrode_i'],\n",
       " 'index': [0, 1, 2, 3, 4, 5, 6, 7, 8],\n",
       " 'index_dtype': 'int64',\n",
       " 'type': 'DataFrame',\n",
       " 'values': [[0, 0, 'electrode087'],\n",
       "  [0, 1, 'electrode053'],\n",
       "  [0, 2, 'electrode006'],\n",
       "  [0, 3, 'electrode007'],\n",
       "  [0, 4, 'electrode067'],\n",
       "  [1, 0, 'electrode009'],\n",
       "  [1, 1, 'electrode065'],\n",
       "  [1, 2, 'electrode066'],\n",
       "  [1, 3, 'electrode067']]}"
      ]
     },
     "execution_count": 2,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "table = {'columns': ['route_i', 'transition_i', 'electrode_i'],\n",
    "         'index_dtype': 'int64',\n",
    "         'type': 'DataFrame'}\n",
    "\n",
    "table['values'] = [[i, j, electrode] for i, route in enumerate(routes)\n",
    "                   for j, electrode in enumerate(route)]\n",
    "table['index'] = range(len(table['values']))\n",
    "table"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "metadata": {
    "ExecuteTime": {
     "end_time": "2019-09-04T17:19:22.109000Z",
     "start_time": "2019-09-04T17:19:21.479000Z"
    }
   },
   "outputs": [
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>route_i</th>\n",
       "      <th>transition_i</th>\n",
       "      <th>electrode_i</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>electrode087</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>electrode053</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>0</td>\n",
       "      <td>2</td>\n",
       "      <td>electrode006</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>0</td>\n",
       "      <td>3</td>\n",
       "      <td>electrode007</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>0</td>\n",
       "      <td>4</td>\n",
       "      <td>electrode067</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>5</th>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>electrode009</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>6</th>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>electrode065</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>7</th>\n",
       "      <td>1</td>\n",
       "      <td>2</td>\n",
       "      <td>electrode066</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>8</th>\n",
       "      <td>1</td>\n",
       "      <td>3</td>\n",
       "      <td>electrode067</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "   route_i  transition_i   electrode_i\n",
       "0        0             0  electrode087\n",
       "1        0             1  electrode053\n",
       "2        0             2  electrode006\n",
       "3        0             3  electrode007\n",
       "4        0             4  electrode067\n",
       "5        1             0  electrode009\n",
       "6        1             1  electrode065\n",
       "7        1             2  electrode066\n",
       "8        1             3  electrode067"
      ]
     },
     "metadata": {},
     "output_type": "display_data"
    },
    {
     "data": {
      "text/markdown": [
       "### Equivalent list of route lists:"
      ],
      "text/plain": [
       "<IPython.core.display.Markdown object>"
      ]
     },
     "metadata": {},
     "output_type": "display_data"
    },
    {
     "data": {
      "text/plain": [
       "[['electrode087',\n",
       "  'electrode053',\n",
       "  'electrode006',\n",
       "  'electrode007',\n",
       "  'electrode067'],\n",
       " ['electrode009', 'electrode065', 'electrode066', 'electrode067']]"
      ]
     },
     "metadata": {},
     "output_type": "display_data"
    }
   ],
   "source": [
    "from IPython.display import Markdown\n",
    "import zmq_plugin as zp\n",
    "import zmq_plugin.schema\n",
    "\n",
    "# See https://github.com/sci-bots/zmq-plugin/blob/50e2e0a805b15ee27a02c0440bdf66caaff0679c/zmq_plugin/schema.py#L555-L596\n",
    "df_routes = zp.schema.pandas_object_hook(table)\n",
    "display(df_routes)\n",
    "display(Markdown('### Equivalent list of route lists:'),\n",
    "        [df_j.electrode_i.tolist()\n",
    "         for route_j, df_j in df_routes.groupby('route_i')])"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 2",
   "language": "python",
   "name": "python2"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 2
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython2",
   "version": "2.7.14"
  },
  "latex_envs": {
   "LaTeX_envs_menu_present": true,
   "autoclose": false,
   "autocomplete": true,
   "bibliofile": "biblio.bib",
   "cite_by": "apalike",
   "current_citInitial": 1,
   "eqLabelWithNumbers": true,
   "eqNumInitial": 1,
   "hotkeys": {
    "equation": "Ctrl-E",
    "itemize": "Ctrl-I"
   },
   "labels_anchors": false,
   "latex_user_defs": false,
   "report_style_numbering": false,
   "user_envs_cfg": false
  },
  "toc": {
   "base_numbering": 1,
   "nav_menu": {},
   "number_sections": true,
   "sideBar": true,
   "skip_h1_title": false,
   "title_cell": "Table of Contents",
   "title_sidebar": "Contents",
   "toc_cell": false,
   "toc_position": {},
   "toc_section_display": true,
   "toc_window_display": false
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}