example.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# PLSXML Examples\n",
    "\n",
    "## Purpose\n",
    "\n",
    "This notebook provides example usages for the PLSXML package."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Class Import"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {},
   "outputs": [],
   "source": [
    "from plsxml import PLSXML\n",
    "from plsxml.data import data_path"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Loading Data\n",
    "\n",
    "To load data from an XML file or ZIP file containing XML files, pass the file path(s) to the class initializer or through the append method:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {},
   "outputs": [],
   "source": [
    "# XML file\n",
    "path = data_path('galloping') # DATA_FOLDER/galloping.xml\n",
    "xml = PLSXML(path)\n",
    "\n",
    "# ZIP file\n",
    "path = data_path('galloping_zip') # DATA_FOLDER/galloping.zip\n",
    "xml = PLSXML(path)\n",
    "\n",
    "# Alternately, use append to add files...\n",
    "xml = PLSXML()\n",
    "xml.append(path)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Multiple XML files may be appended to the same class container. Duplicate rows of data will automatically be dropped, with the first row loaded being retained."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Listing Keys\n",
    "\n",
    "Calling the `table_summary` method will provide a list of parsed tables, keys, and example data. This may be useful when determining which tables and data you want to work with. An example output is below:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "\n",
      "galloping_ellipses_summary\n",
      "\trowtext                                                     \tNone\n",
      "\tstructure                                                   \tTERM\n",
      "\tset                                                         \t1\n",
      "\tphase                                                       \t1\n",
      "\tahead_span_length                                           \t258.2\n",
      "\tminimum_clearance_set                                       \t1\n",
      "\tminimum_clearance_phase                                     \t2\n",
      "\tminimum_clearance_galloping_ellipse_method                  \tSingle mid span\n",
      "\tminimum_clearance_distance                                  \t1.52\n",
      "\tminimum_clearance_overlap                                   \t0.0\n",
      "\tminimum_clearance_wind_from                                 \tLeft\n",
      "\tminimum_clearance_mid_span_sag                              \t12.15\n",
      "\tminimum_clearance_insulator_swing_angle                     \t0.0\n",
      "\tminimum_clearance_span_swing_angle                          \t63.1\n",
      "\tminimum_clearance_major_axis_length                         \t16.2\n",
      "\tminimum_clearance_minor_axis_length                         \t6.5\n",
      "\tminimum_clearance_b_distance                                \t3.0\n",
      "\n"
     ]
    }
   ],
   "source": [
    "print(xml.table_summary())"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Retrieving Parsed Data\n",
    "\n",
    "The class is a subclass of a dictionary. The data itself is contained within `pandas` DataFrames within that class dictionary. Data can be accessed through the heirarchy:\n",
    "\n",
    "```\n",
    "xml[table_key][column_index][row_index]\n",
    "```\n",
    "\n",
    "Examples:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "'Single mid span'"
      ]
     },
     "execution_count": 4,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Specific index value\n",
    "xml['galloping_ellipses_summary']['minimum_clearance_galloping_ellipse_method'][0]"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "metadata": {},
   "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>rowtext</th>\n",
       "      <th>structure</th>\n",
       "      <th>set</th>\n",
       "      <th>phase</th>\n",
       "      <th>ahead_span_length</th>\n",
       "      <th>minimum_clearance_set</th>\n",
       "      <th>minimum_clearance_phase</th>\n",
       "      <th>minimum_clearance_galloping_ellipse_method</th>\n",
       "      <th>minimum_clearance_distance</th>\n",
       "      <th>minimum_clearance_overlap</th>\n",
       "      <th>minimum_clearance_wind_from</th>\n",
       "      <th>minimum_clearance_mid_span_sag</th>\n",
       "      <th>minimum_clearance_insulator_swing_angle</th>\n",
       "      <th>minimum_clearance_span_swing_angle</th>\n",
       "      <th>minimum_clearance_major_axis_length</th>\n",
       "      <th>minimum_clearance_minor_axis_length</th>\n",
       "      <th>minimum_clearance_b_distance</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>None</td>\n",
       "      <td>TERM</td>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>258.2</td>\n",
       "      <td>1</td>\n",
       "      <td>2</td>\n",
       "      <td>Single mid span</td>\n",
       "      <td>1.52</td>\n",
       "      <td>0.0</td>\n",
       "      <td>Left</td>\n",
       "      <td>12.15</td>\n",
       "      <td>0.0</td>\n",
       "      <td>63.1</td>\n",
       "      <td>16.2</td>\n",
       "      <td>6.5</td>\n",
       "      <td>3.0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>None</td>\n",
       "      <td>TERM</td>\n",
       "      <td>1</td>\n",
       "      <td>2</td>\n",
       "      <td>259.6</td>\n",
       "      <td>1</td>\n",
       "      <td>3</td>\n",
       "      <td>Single mid span</td>\n",
       "      <td>1.48</td>\n",
       "      <td>0.0</td>\n",
       "      <td>Left</td>\n",
       "      <td>11.85</td>\n",
       "      <td>0.0</td>\n",
       "      <td>63.1</td>\n",
       "      <td>15.8</td>\n",
       "      <td>6.3</td>\n",
       "      <td>3.0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>None</td>\n",
       "      <td>TERM</td>\n",
       "      <td>1</td>\n",
       "      <td>3</td>\n",
       "      <td>261.9</td>\n",
       "      <td>1</td>\n",
       "      <td>2</td>\n",
       "      <td>Single mid span</td>\n",
       "      <td>1.48</td>\n",
       "      <td>0.0</td>\n",
       "      <td>Left</td>\n",
       "      <td>11.60</td>\n",
       "      <td>0.0</td>\n",
       "      <td>63.1</td>\n",
       "      <td>15.5</td>\n",
       "      <td>6.2</td>\n",
       "      <td>2.9</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>NG</td>\n",
       "      <td>133</td>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>944.0</td>\n",
       "      <td>1</td>\n",
       "      <td>2</td>\n",
       "      <td>CIGRE 322</td>\n",
       "      <td>0.00</td>\n",
       "      <td>23.3</td>\n",
       "      <td>Right</td>\n",
       "      <td>48.72</td>\n",
       "      <td>0.0</td>\n",
       "      <td>-63.1</td>\n",
       "      <td>30.1</td>\n",
       "      <td>12.0</td>\n",
       "      <td>9.0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>NG</td>\n",
       "      <td>133</td>\n",
       "      <td>1</td>\n",
       "      <td>2</td>\n",
       "      <td>942.7</td>\n",
       "      <td>1</td>\n",
       "      <td>3</td>\n",
       "      <td>CIGRE 322</td>\n",
       "      <td>0.00</td>\n",
       "      <td>29.8</td>\n",
       "      <td>Left</td>\n",
       "      <td>48.58</td>\n",
       "      <td>0.0</td>\n",
       "      <td>63.1</td>\n",
       "      <td>30.0</td>\n",
       "      <td>12.0</td>\n",
       "      <td>9.0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>5</th>\n",
       "      <td>NG</td>\n",
       "      <td>133</td>\n",
       "      <td>1</td>\n",
       "      <td>3</td>\n",
       "      <td>941.9</td>\n",
       "      <td>1</td>\n",
       "      <td>2</td>\n",
       "      <td>CIGRE 322</td>\n",
       "      <td>0.00</td>\n",
       "      <td>29.8</td>\n",
       "      <td>Left</td>\n",
       "      <td>48.49</td>\n",
       "      <td>0.0</td>\n",
       "      <td>63.1</td>\n",
       "      <td>30.0</td>\n",
       "      <td>12.0</td>\n",
       "      <td>9.0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>6</th>\n",
       "      <td>NG</td>\n",
       "      <td>605</td>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>775.7</td>\n",
       "      <td>1</td>\n",
       "      <td>2</td>\n",
       "      <td>CIGRE 322</td>\n",
       "      <td>0.00</td>\n",
       "      <td>12.2</td>\n",
       "      <td>Left</td>\n",
       "      <td>24.34</td>\n",
       "      <td>0.0</td>\n",
       "      <td>63.1</td>\n",
       "      <td>25.5</td>\n",
       "      <td>10.2</td>\n",
       "      <td>7.6</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>7</th>\n",
       "      <td>NG</td>\n",
       "      <td>605</td>\n",
       "      <td>1</td>\n",
       "      <td>2</td>\n",
       "      <td>777.1</td>\n",
       "      <td>1</td>\n",
       "      <td>3</td>\n",
       "      <td>CIGRE 322</td>\n",
       "      <td>0.00</td>\n",
       "      <td>12.3</td>\n",
       "      <td>Left</td>\n",
       "      <td>24.43</td>\n",
       "      <td>0.0</td>\n",
       "      <td>63.1</td>\n",
       "      <td>25.5</td>\n",
       "      <td>10.2</td>\n",
       "      <td>7.7</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>8</th>\n",
       "      <td>NG</td>\n",
       "      <td>605</td>\n",
       "      <td>1</td>\n",
       "      <td>3</td>\n",
       "      <td>775.7</td>\n",
       "      <td>1</td>\n",
       "      <td>2</td>\n",
       "      <td>CIGRE 322</td>\n",
       "      <td>0.00</td>\n",
       "      <td>12.4</td>\n",
       "      <td>Left</td>\n",
       "      <td>24.34</td>\n",
       "      <td>0.0</td>\n",
       "      <td>63.1</td>\n",
       "      <td>25.5</td>\n",
       "      <td>10.2</td>\n",
       "      <td>7.6</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>9</th>\n",
       "      <td>NG</td>\n",
       "      <td>606</td>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>1616.5</td>\n",
       "      <td>1</td>\n",
       "      <td>2</td>\n",
       "      <td>CIGRE 322</td>\n",
       "      <td>0.00</td>\n",
       "      <td>27.0</td>\n",
       "      <td>Left</td>\n",
       "      <td>68.08</td>\n",
       "      <td>63.6</td>\n",
       "      <td>63.1</td>\n",
       "      <td>32.3</td>\n",
       "      <td>12.9</td>\n",
       "      <td>9.7</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "  rowtext structure  set  phase  ahead_span_length  minimum_clearance_set  \\\n",
       "0    None      TERM    1      1              258.2                      1   \n",
       "1    None      TERM    1      2              259.6                      1   \n",
       "2    None      TERM    1      3              261.9                      1   \n",
       "3    NG         133    1      1              944.0                      1   \n",
       "4    NG         133    1      2              942.7                      1   \n",
       "5    NG         133    1      3              941.9                      1   \n",
       "6    NG         605    1      1              775.7                      1   \n",
       "7    NG         605    1      2              777.1                      1   \n",
       "8    NG         605    1      3              775.7                      1   \n",
       "9    NG         606    1      1             1616.5                      1   \n",
       "\n",
       "   minimum_clearance_phase minimum_clearance_galloping_ellipse_method  \\\n",
       "0                        2                            Single mid span   \n",
       "1                        3                            Single mid span   \n",
       "2                        2                            Single mid span   \n",
       "3                        2                                 CIGRE 322    \n",
       "4                        3                                 CIGRE 322    \n",
       "5                        2                                 CIGRE 322    \n",
       "6                        2                                 CIGRE 322    \n",
       "7                        3                                 CIGRE 322    \n",
       "8                        2                                 CIGRE 322    \n",
       "9                        2                                 CIGRE 322    \n",
       "\n",
       "   minimum_clearance_distance  minimum_clearance_overlap  \\\n",
       "0                        1.52                        0.0   \n",
       "1                        1.48                        0.0   \n",
       "2                        1.48                        0.0   \n",
       "3                        0.00                       23.3   \n",
       "4                        0.00                       29.8   \n",
       "5                        0.00                       29.8   \n",
       "6                        0.00                       12.2   \n",
       "7                        0.00                       12.3   \n",
       "8                        0.00                       12.4   \n",
       "9                        0.00                       27.0   \n",
       "\n",
       "  minimum_clearance_wind_from  minimum_clearance_mid_span_sag  \\\n",
       "0                        Left                           12.15   \n",
       "1                        Left                           11.85   \n",
       "2                        Left                           11.60   \n",
       "3                       Right                           48.72   \n",
       "4                        Left                           48.58   \n",
       "5                        Left                           48.49   \n",
       "6                        Left                           24.34   \n",
       "7                        Left                           24.43   \n",
       "8                        Left                           24.34   \n",
       "9                        Left                           68.08   \n",
       "\n",
       "   minimum_clearance_insulator_swing_angle  \\\n",
       "0                                      0.0   \n",
       "1                                      0.0   \n",
       "2                                      0.0   \n",
       "3                                      0.0   \n",
       "4                                      0.0   \n",
       "5                                      0.0   \n",
       "6                                      0.0   \n",
       "7                                      0.0   \n",
       "8                                      0.0   \n",
       "9                                     63.6   \n",
       "\n",
       "   minimum_clearance_span_swing_angle  minimum_clearance_major_axis_length  \\\n",
       "0                                63.1                                 16.2   \n",
       "1                                63.1                                 15.8   \n",
       "2                                63.1                                 15.5   \n",
       "3                               -63.1                                 30.1   \n",
       "4                                63.1                                 30.0   \n",
       "5                                63.1                                 30.0   \n",
       "6                                63.1                                 25.5   \n",
       "7                                63.1                                 25.5   \n",
       "8                                63.1                                 25.5   \n",
       "9                                63.1                                 32.3   \n",
       "\n",
       "   minimum_clearance_minor_axis_length  minimum_clearance_b_distance  \n",
       "0                                  6.5                           3.0  \n",
       "1                                  6.3                           3.0  \n",
       "2                                  6.2                           2.9  \n",
       "3                                 12.0                           9.0  \n",
       "4                                 12.0                           9.0  \n",
       "5                                 12.0                           9.0  \n",
       "6                                 10.2                           7.6  \n",
       "7                                 10.2                           7.7  \n",
       "8                                 10.2                           7.6  \n",
       "9                                 12.9                           9.7  "
      ]
     },
     "execution_count": 5,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Slice of pandas dataframe\n",
    "xml['galloping_ellipses_summary'][:10]"
   ]
  }
 ],
 "metadata": {
  "hide_input": false,
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.6.5"
  },
  "toc": {
   "base_numbering": 1,
   "nav_menu": {},
   "number_sections": false,
   "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
  },
  "varInspector": {
   "cols": {
    "lenName": 16,
    "lenType": 16,
    "lenVar": 40
   },
   "kernels_config": {
    "python": {
     "delete_cmd_postfix": "",
     "delete_cmd_prefix": "del ",
     "library": "var_list.py",
     "varRefreshCmd": "print(var_dic_list())"
    },
    "r": {
     "delete_cmd_postfix": ") ",
     "delete_cmd_prefix": "rm(",
     "library": "var_list.r",
     "varRefreshCmd": "cat(var_dic_list()) "
    }
   },
   "types_to_exclude": [
    "module",
    "function",
    "builtin_function_or_method",
    "instance",
    "_Feature"
   ],
   "window_display": false
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}