Tutorials/Getting_Started.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "5068d4b8-4c8f-48ef-b02e-56e5dcafa004",
   "metadata": {},
   "source": [
    "# Getting started"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "a6478cbd-c3a3-4c57-9688-399a1f5b62a5",
   "metadata": {},
   "source": [
    "## Welcome to the hex maze project! There are a variety of tutorial notebooks to help you get started.\n",
    "\n",
    "### First, read through this notebook fully to understand the basics of how everything works, __then__ move on to the tutorials for your specific needs.\n",
    "\n",
    "The most useful ones will probably be these:\n",
    "- [Plotting hex mazes and barrier change sequences (`Plotting_Hex_Mazes.ipynb`)](Plotting_Hex_Mazes.ipynb)\n",
    "- [Searching the maze configuration database for the mazes you want (`Maze_Configuration_Database_Search.ipynb`)](Maze_Configuration_Database_Search.ipynb)\n",
    "- [Searching the barrier sequence database for the sequence you want (`Barrier_Sequence_Database_Search.ipynb`)](Barrier_Sequence_Database_Search.ipynb)\n",
    "- [Generating a custom barrier sequence database with the criteria you want (`Generate_Custom_Barrier_Sequence_Database.ipynb`)](Generate_Custom_Barrier_Sequence_Database.ipynb)\n",
    "- [Demos of useful hex maze functions (`Hex_Maze_Functions.ipynb`)](Hex_Maze_Functions.ipynb)\n",
    "\n",
    "Because the maze configuration databases have already been generated, you probably will not need these unless you are generating new hex mazes with different criteria. Still, it can be very useful to understand how things were created!\n",
    "- [How the hex maze database was generated (`Generate_Hex_Maze_Database.ipynb`)](Generate_Hex_Maze_Database.ipynb)\n",
    "- [How the probability change maze database was generated (`Generate_Probability_Change_Database.ipynb`)](Generate_Probability_Change_Database.ipynb)\n",
    "- [How the training maze database was generated (`Generate_Training_Maze_Database.ipynb`)](Generate_Training_Maze_Database.ipynb)\n",
    "\n",
    "An old tutorial notebook on generating barrier sequence databases - replaced by `Generate_Custom_Barrier_Sequence_Database.ipynb` and will eventually be removed.\n",
    "- [How the barrier sequence database was generated (`Generate_Barrier_Sequence_Database_OLD.ipynb`)](Generate_Barrier_Sequence_Database_OLD.ipynb)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "9aff2e58-4e0e-4b5b-b9b0-13a18dd56c98",
   "metadata": {},
   "source": [
    "### First things first: This repo is all about the __hex maze__. \n",
    "\n",
    "There are 49 open hexes in the hex maze, numbered 1-49. We represent a hex maze as a set of integers defining where the barriers are placed. Often in this repo, hex maze configurations are also referred to as \"barrier sets\" or simply \"barriers\". \n",
    "\n",
    "Given this set of integers defining where barriers are placed in the hex maze, we can calculate everything else we need to know about the maze (critical choice points, lengths of reward paths, the optimal paths between ports, etc.)\n",
    "\n",
    "### Sets of sequential hex mazes that each differ by the movement of a single barrier are called __barrier sequences__.\n",
    "\n",
    "We represent barrier sequences as a list of sets, where each set defines a hex maze. "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "id": "d41abc8e-fe69-4cdc-8412-a1dad3285318",
   "metadata": {},
   "outputs": [],
   "source": [
    "# Most of your notebooks will start with some general imports\n",
    "import pickle\n",
    "import pandas as pd\n",
    "import numpy as np\n",
    "import sys\n",
    "sys.path.append(\"..\")  # Use sys to add the parent directory (where hex_maze_utils lives) to the path"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "id": "fd2c470c-153f-4bfa-9c74-5864d9f5aeac",
   "metadata": {},
   "outputs": [],
   "source": [
    "# Hex maze configurations are represented as a set of barriers.\n",
    "example_maze = {37, 7, 39, 41, 14, 46, 20, 23, 30}\n",
    "\n",
    "# Barrier change sequences are represented as a list of sequential sets of barriers.\n",
    "example_barrier_sequence = [{37, 7, 39, 41, 14, 46, 20, 23, 30}, {37, 39, 7, 46, 14, 16, 20, 23, 30},\n",
    "                            {37, 39, 7, 46, 14, 18, 20, 23, 30}, {39, 7, 46, 14, 18, 20, 23, 26, 30}, \n",
    "                            {35, 39, 7, 46, 14, 18, 20, 23, 26}]"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "9598acf7-4d1c-4f35-9682-b100d29346d3",
   "metadata": {},
   "source": [
    "##### &rArr; __Next steps__: To learn about plotting hex mazes and barrier sequences, check out [`Plotting_Hex_Mazes.ipynb`](Plotting_Hex_Mazes.ipynb)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "c1383879-7159-402d-84d3-32c74dd3afa2",
   "metadata": {},
   "source": [
    "### The databases\n",
    "We've created a database of lots of different hex maze configurations (and their attributes), and lots of barrier sequences (and their attributes). Many of your notebooks will probably start by loading one or both of these databases."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "id": "6295e036-766d-41ae-8f38-1b5e1b64bc9e",
   "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>barriers</th>\n",
       "      <th>len12</th>\n",
       "      <th>len13</th>\n",
       "      <th>len23</th>\n",
       "      <th>reward_path_lengths</th>\n",
       "      <th>path_length_difference</th>\n",
       "      <th>optimal_paths_12</th>\n",
       "      <th>optimal_paths_13</th>\n",
       "      <th>optimal_paths_23</th>\n",
       "      <th>optimal_paths_all</th>\n",
       "      <th>choice_points</th>\n",
       "      <th>num_choice_points</th>\n",
       "      <th>cycles</th>\n",
       "      <th>num_cycles</th>\n",
       "      <th>isomorphic_mazes</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>(37, 39, 7, 41, 14, 46, 20, 23, 30)</td>\n",
       "      <td>15</td>\n",
       "      <td>17</td>\n",
       "      <td>21</td>\n",
       "      <td>[15, 17, 21]</td>\n",
       "      <td>6</td>\n",
       "      <td>[[1, 4, 6, 8, 10, 13, 17, 21, 26, 22, 27, 32, ...</td>\n",
       "      <td>[[1, 4, 6, 8, 10, 13, 16, 12, 15, 19, 24, 29, ...</td>\n",
       "      <td>[[2, 49, 38, 32, 27, 22, 26, 21, 17, 13, 16, 1...</td>\n",
       "      <td>[[1, 4, 6, 8, 10, 13, 17, 21, 26, 22, 27, 32, ...</td>\n",
       "      <td>{13}</td>\n",
       "      <td>1</td>\n",
       "      <td>[]</td>\n",
       "      <td>0</td>\n",
       "      <td>{(37, 8, 9, 40, 20, 21, 22, 27, 28), (34, 8, 4...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>(34, 36, 37, 39, 10, 45, 14, 15, 20)</td>\n",
       "      <td>17</td>\n",
       "      <td>21</td>\n",
       "      <td>19</td>\n",
       "      <td>[17, 21, 19]</td>\n",
       "      <td>4</td>\n",
       "      <td>[[1, 4, 5, 7, 9, 12, 16, 13, 17, 21, 26, 22, 2...</td>\n",
       "      <td>[[1, 4, 5, 7, 9, 12, 16, 13, 17, 21, 25, 30, 3...</td>\n",
       "      <td>[[2, 49, 38, 32, 27, 22, 26, 21, 25, 30, 35, 2...</td>\n",
       "      <td>[[1, 4, 5, 7, 9, 12, 16, 13, 17, 21, 26, 22, 2...</td>\n",
       "      <td>{21}</td>\n",
       "      <td>1</td>\n",
       "      <td>[]</td>\n",
       "      <td>0</td>\n",
       "      <td>{(34, 37, 8, 40, 10, 15, 18, 20, 26), (34, 35,...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>(34, 7, 41, 11, 46, 17, 20, 28, 31)</td>\n",
       "      <td>23</td>\n",
       "      <td>19</td>\n",
       "      <td>17</td>\n",
       "      <td>[23, 19, 17]</td>\n",
       "      <td>6</td>\n",
       "      <td>[[1, 4, 6, 8, 10, 13, 16, 12, 15, 19, 24, 29, ...</td>\n",
       "      <td>[[1, 4, 6, 8, 10, 13, 16, 12, 15, 19, 24, 29, ...</td>\n",
       "      <td>[[2, 49, 38, 32, 27, 22, 26, 21, 25, 30, 35, 4...</td>\n",
       "      <td>[[1, 4, 6, 8, 10, 13, 16, 12, 15, 19, 24, 29, ...</td>\n",
       "      <td>{35}</td>\n",
       "      <td>1</td>\n",
       "      <td>[[38, 49, 47, 42, 37, 32]]</td>\n",
       "      <td>1</td>\n",
       "      <td>{(35, 7, 10, 44, 20, 22, 27, 28, 31), (32, 37,...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>(34, 10, 42, 12, 45, 18, 23, 25, 31)</td>\n",
       "      <td>15</td>\n",
       "      <td>19</td>\n",
       "      <td>21</td>\n",
       "      <td>[15, 19, 21]</td>\n",
       "      <td>6</td>\n",
       "      <td>[[1, 4, 6, 8, 11, 14, 17, 21, 26, 22, 27, 32, ...</td>\n",
       "      <td>[[1, 4, 6, 8, 11, 14, 17, 13, 16, 20, 24, 29, ...</td>\n",
       "      <td>[[2, 49, 38, 32, 27, 22, 26, 21, 17, 13, 16, 2...</td>\n",
       "      <td>[[1, 4, 6, 8, 11, 14, 17, 21, 26, 22, 27, 32, ...</td>\n",
       "      <td>{17}</td>\n",
       "      <td>1</td>\n",
       "      <td>[]</td>\n",
       "      <td>0</td>\n",
       "      <td>{(34, 37, 8, 40, 13, 46, 15, 18, 25), (34, 37,...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>(39, 9, 10, 46, 21, 22, 23, 26, 30)</td>\n",
       "      <td>23</td>\n",
       "      <td>17</td>\n",
       "      <td>17</td>\n",
       "      <td>[23, 17, 17]</td>\n",
       "      <td>6</td>\n",
       "      <td>[[1, 4, 6, 8, 11, 14, 17, 13, 16, 20, 24, 29, ...</td>\n",
       "      <td>[[1, 4, 6, 8, 11, 14, 17, 13, 16, 20, 24, 29, ...</td>\n",
       "      <td>[[2, 49, 38, 32, 37, 31, 36, 41, 45, 40, 35, 2...</td>\n",
       "      <td>[[1, 4, 6, 8, 11, 14, 17, 13, 16, 20, 24, 29, ...</td>\n",
       "      <td>{29}</td>\n",
       "      <td>1</td>\n",
       "      <td>[[32, 38, 49, 47, 42, 37], [12, 15, 19, 24, 20...</td>\n",
       "      <td>2</td>\n",
       "      <td>{(34, 36, 8, 41, 9, 21, 23, 27, 30), (10, 11, ...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>...</th>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>55891</th>\n",
       "      <td>(34, 36, 7, 10, 42, 46, 19, 22, 25)</td>\n",
       "      <td>15</td>\n",
       "      <td>19</td>\n",
       "      <td>21</td>\n",
       "      <td>[15, 19, 21]</td>\n",
       "      <td>6</td>\n",
       "      <td>[[1, 4, 6, 8, 11, 14, 17, 21, 26, 31, 37, 32, ...</td>\n",
       "      <td>[[1, 4, 6, 8, 11, 14, 17, 13, 16, 20, 24, 29, ...</td>\n",
       "      <td>[[2, 49, 38, 32, 37, 31, 26, 21, 17, 13, 16, 2...</td>\n",
       "      <td>[[1, 4, 6, 8, 11, 14, 17, 21, 26, 31, 37, 32, ...</td>\n",
       "      <td>{17}</td>\n",
       "      <td>1</td>\n",
       "      <td>[]</td>\n",
       "      <td>0</td>\n",
       "      <td>{(34, 37, 7, 40, 9, 42, 14, 16, 25), (35, 37, ...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>55892</th>\n",
       "      <td>(37, 7, 9, 13, 45, 16, 22, 25, 29)</td>\n",
       "      <td>17</td>\n",
       "      <td>19</td>\n",
       "      <td>15</td>\n",
       "      <td>[17, 19, 15]</td>\n",
       "      <td>4</td>\n",
       "      <td>[[1, 4, 6, 8, 11, 14, 17, 21, 26, 31, 36, 41, ...</td>\n",
       "      <td>[[1, 4, 6, 8, 11, 14, 17, 21, 26, 31, 36, 30, ...</td>\n",
       "      <td>[[2, 49, 47, 42, 46, 41, 36, 30, 35, 40, 44, 3...</td>\n",
       "      <td>[[1, 4, 6, 8, 11, 14, 17, 21, 26, 31, 36, 41, ...</td>\n",
       "      <td>{36}</td>\n",
       "      <td>1</td>\n",
       "      <td>[[34, 28, 33, 48, 43, 39]]</td>\n",
       "      <td>1</td>\n",
       "      <td>{(32, 34, 40, 13, 15, 25, 26, 27, 31), (36, 10...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>55893</th>\n",
       "      <td>(7, 39, 46, 17, 19, 22, 23, 24, 30)</td>\n",
       "      <td>17</td>\n",
       "      <td>23</td>\n",
       "      <td>17</td>\n",
       "      <td>[17, 23, 17]</td>\n",
       "      <td>6</td>\n",
       "      <td>[[1, 4, 6, 8, 10, 13, 16, 20, 25, 21, 26, 31, ...</td>\n",
       "      <td>[[1, 4, 6, 8, 10, 13, 16, 20, 25, 21, 26, 31, ...</td>\n",
       "      <td>[[2, 49, 38, 32, 37, 31, 36, 41, 45, 40, 35, 2...</td>\n",
       "      <td>[[1, 4, 6, 8, 10, 13, 16, 20, 25, 21, 26, 31, ...</td>\n",
       "      <td>{31}</td>\n",
       "      <td>1</td>\n",
       "      <td>[[32, 38, 49, 47, 42, 37]]</td>\n",
       "      <td>1</td>\n",
       "      <td>{(32, 36, 7, 40, 11, 14, 17, 20, 23), (32, 36,...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>55894</th>\n",
       "      <td>(34, 10, 11, 42, 45, 15, 22, 25, 30)</td>\n",
       "      <td>17</td>\n",
       "      <td>15</td>\n",
       "      <td>19</td>\n",
       "      <td>[17, 15, 19]</td>\n",
       "      <td>4</td>\n",
       "      <td>[[1, 4, 5, 7, 9, 12, 16, 13, 17, 21, 26, 31, 3...</td>\n",
       "      <td>[[1, 4, 5, 7, 9, 12, 16, 20, 24, 19, 23, 28, 3...</td>\n",
       "      <td>[[2, 49, 38, 32, 37, 31, 26, 21, 17, 13, 16, 2...</td>\n",
       "      <td>[[1, 4, 5, 7, 9, 12, 16, 13, 17, 21, 26, 31, 3...</td>\n",
       "      <td>{16}</td>\n",
       "      <td>1</td>\n",
       "      <td>[[19, 23, 28, 33, 48, 43, 39, 44, 40, 35, 29, ...</td>\n",
       "      <td>1</td>\n",
       "      <td>{(34, 37, 8, 12, 45, 18, 21, 23, 25), (37, 40,...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>55895</th>\n",
       "      <td>(32, 37, 8, 45, 15, 20, 21, 27, 29)</td>\n",
       "      <td>19</td>\n",
       "      <td>21</td>\n",
       "      <td>15</td>\n",
       "      <td>[19, 21, 15]</td>\n",
       "      <td>6</td>\n",
       "      <td>[[1, 4, 5, 7, 10, 13, 17, 14, 18, 22, 26, 31, ...</td>\n",
       "      <td>[[1, 4, 5, 7, 10, 13, 17, 14, 18, 22, 26, 31, ...</td>\n",
       "      <td>[[2, 49, 47, 42, 46, 41, 36, 30, 35, 40, 44, 3...</td>\n",
       "      <td>[[1, 4, 5, 7, 10, 13, 17, 14, 18, 22, 26, 31, ...</td>\n",
       "      <td>{36}</td>\n",
       "      <td>1</td>\n",
       "      <td>[[10, 13, 16, 12, 9, 7], [34, 28, 33, 48, 43, ...</td>\n",
       "      <td>2</td>\n",
       "      <td>{(37, 39, 42, 13, 46, 15, 18, 20, 30), (34, 7,...</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "<p>55896 rows × 15 columns</p>\n",
       "</div>"
      ],
      "text/plain": [
       "                                   barriers  len12  len13  len23  \\\n",
       "0       (37, 39, 7, 41, 14, 46, 20, 23, 30)     15     17     21   \n",
       "1      (34, 36, 37, 39, 10, 45, 14, 15, 20)     17     21     19   \n",
       "2       (34, 7, 41, 11, 46, 17, 20, 28, 31)     23     19     17   \n",
       "3      (34, 10, 42, 12, 45, 18, 23, 25, 31)     15     19     21   \n",
       "4       (39, 9, 10, 46, 21, 22, 23, 26, 30)     23     17     17   \n",
       "...                                     ...    ...    ...    ...   \n",
       "55891   (34, 36, 7, 10, 42, 46, 19, 22, 25)     15     19     21   \n",
       "55892    (37, 7, 9, 13, 45, 16, 22, 25, 29)     17     19     15   \n",
       "55893   (7, 39, 46, 17, 19, 22, 23, 24, 30)     17     23     17   \n",
       "55894  (34, 10, 11, 42, 45, 15, 22, 25, 30)     17     15     19   \n",
       "55895   (32, 37, 8, 45, 15, 20, 21, 27, 29)     19     21     15   \n",
       "\n",
       "      reward_path_lengths  path_length_difference  \\\n",
       "0            [15, 17, 21]                       6   \n",
       "1            [17, 21, 19]                       4   \n",
       "2            [23, 19, 17]                       6   \n",
       "3            [15, 19, 21]                       6   \n",
       "4            [23, 17, 17]                       6   \n",
       "...                   ...                     ...   \n",
       "55891        [15, 19, 21]                       6   \n",
       "55892        [17, 19, 15]                       4   \n",
       "55893        [17, 23, 17]                       6   \n",
       "55894        [17, 15, 19]                       4   \n",
       "55895        [19, 21, 15]                       6   \n",
       "\n",
       "                                        optimal_paths_12  \\\n",
       "0      [[1, 4, 6, 8, 10, 13, 17, 21, 26, 22, 27, 32, ...   \n",
       "1      [[1, 4, 5, 7, 9, 12, 16, 13, 17, 21, 26, 22, 2...   \n",
       "2      [[1, 4, 6, 8, 10, 13, 16, 12, 15, 19, 24, 29, ...   \n",
       "3      [[1, 4, 6, 8, 11, 14, 17, 21, 26, 22, 27, 32, ...   \n",
       "4      [[1, 4, 6, 8, 11, 14, 17, 13, 16, 20, 24, 29, ...   \n",
       "...                                                  ...   \n",
       "55891  [[1, 4, 6, 8, 11, 14, 17, 21, 26, 31, 37, 32, ...   \n",
       "55892  [[1, 4, 6, 8, 11, 14, 17, 21, 26, 31, 36, 41, ...   \n",
       "55893  [[1, 4, 6, 8, 10, 13, 16, 20, 25, 21, 26, 31, ...   \n",
       "55894  [[1, 4, 5, 7, 9, 12, 16, 13, 17, 21, 26, 31, 3...   \n",
       "55895  [[1, 4, 5, 7, 10, 13, 17, 14, 18, 22, 26, 31, ...   \n",
       "\n",
       "                                        optimal_paths_13  \\\n",
       "0      [[1, 4, 6, 8, 10, 13, 16, 12, 15, 19, 24, 29, ...   \n",
       "1      [[1, 4, 5, 7, 9, 12, 16, 13, 17, 21, 25, 30, 3...   \n",
       "2      [[1, 4, 6, 8, 10, 13, 16, 12, 15, 19, 24, 29, ...   \n",
       "3      [[1, 4, 6, 8, 11, 14, 17, 13, 16, 20, 24, 29, ...   \n",
       "4      [[1, 4, 6, 8, 11, 14, 17, 13, 16, 20, 24, 29, ...   \n",
       "...                                                  ...   \n",
       "55891  [[1, 4, 6, 8, 11, 14, 17, 13, 16, 20, 24, 29, ...   \n",
       "55892  [[1, 4, 6, 8, 11, 14, 17, 21, 26, 31, 36, 30, ...   \n",
       "55893  [[1, 4, 6, 8, 10, 13, 16, 20, 25, 21, 26, 31, ...   \n",
       "55894  [[1, 4, 5, 7, 9, 12, 16, 20, 24, 19, 23, 28, 3...   \n",
       "55895  [[1, 4, 5, 7, 10, 13, 17, 14, 18, 22, 26, 31, ...   \n",
       "\n",
       "                                        optimal_paths_23  \\\n",
       "0      [[2, 49, 38, 32, 27, 22, 26, 21, 17, 13, 16, 1...   \n",
       "1      [[2, 49, 38, 32, 27, 22, 26, 21, 25, 30, 35, 2...   \n",
       "2      [[2, 49, 38, 32, 27, 22, 26, 21, 25, 30, 35, 4...   \n",
       "3      [[2, 49, 38, 32, 27, 22, 26, 21, 17, 13, 16, 2...   \n",
       "4      [[2, 49, 38, 32, 37, 31, 36, 41, 45, 40, 35, 2...   \n",
       "...                                                  ...   \n",
       "55891  [[2, 49, 38, 32, 37, 31, 26, 21, 17, 13, 16, 2...   \n",
       "55892  [[2, 49, 47, 42, 46, 41, 36, 30, 35, 40, 44, 3...   \n",
       "55893  [[2, 49, 38, 32, 37, 31, 36, 41, 45, 40, 35, 2...   \n",
       "55894  [[2, 49, 38, 32, 37, 31, 26, 21, 17, 13, 16, 2...   \n",
       "55895  [[2, 49, 47, 42, 46, 41, 36, 30, 35, 40, 44, 3...   \n",
       "\n",
       "                                       optimal_paths_all choice_points  \\\n",
       "0      [[1, 4, 6, 8, 10, 13, 17, 21, 26, 22, 27, 32, ...          {13}   \n",
       "1      [[1, 4, 5, 7, 9, 12, 16, 13, 17, 21, 26, 22, 2...          {21}   \n",
       "2      [[1, 4, 6, 8, 10, 13, 16, 12, 15, 19, 24, 29, ...          {35}   \n",
       "3      [[1, 4, 6, 8, 11, 14, 17, 21, 26, 22, 27, 32, ...          {17}   \n",
       "4      [[1, 4, 6, 8, 11, 14, 17, 13, 16, 20, 24, 29, ...          {29}   \n",
       "...                                                  ...           ...   \n",
       "55891  [[1, 4, 6, 8, 11, 14, 17, 21, 26, 31, 37, 32, ...          {17}   \n",
       "55892  [[1, 4, 6, 8, 11, 14, 17, 21, 26, 31, 36, 41, ...          {36}   \n",
       "55893  [[1, 4, 6, 8, 10, 13, 16, 20, 25, 21, 26, 31, ...          {31}   \n",
       "55894  [[1, 4, 5, 7, 9, 12, 16, 13, 17, 21, 26, 31, 3...          {16}   \n",
       "55895  [[1, 4, 5, 7, 10, 13, 17, 14, 18, 22, 26, 31, ...          {36}   \n",
       "\n",
       "       num_choice_points                                             cycles  \\\n",
       "0                      1                                                 []   \n",
       "1                      1                                                 []   \n",
       "2                      1                         [[38, 49, 47, 42, 37, 32]]   \n",
       "3                      1                                                 []   \n",
       "4                      1  [[32, 38, 49, 47, 42, 37], [12, 15, 19, 24, 20...   \n",
       "...                  ...                                                ...   \n",
       "55891                  1                                                 []   \n",
       "55892                  1                         [[34, 28, 33, 48, 43, 39]]   \n",
       "55893                  1                         [[32, 38, 49, 47, 42, 37]]   \n",
       "55894                  1  [[19, 23, 28, 33, 48, 43, 39, 44, 40, 35, 29, ...   \n",
       "55895                  1  [[10, 13, 16, 12, 9, 7], [34, 28, 33, 48, 43, ...   \n",
       "\n",
       "       num_cycles                                   isomorphic_mazes  \n",
       "0               0  {(37, 8, 9, 40, 20, 21, 22, 27, 28), (34, 8, 4...  \n",
       "1               0  {(34, 37, 8, 40, 10, 15, 18, 20, 26), (34, 35,...  \n",
       "2               1  {(35, 7, 10, 44, 20, 22, 27, 28, 31), (32, 37,...  \n",
       "3               0  {(34, 37, 8, 40, 13, 46, 15, 18, 25), (34, 37,...  \n",
       "4               2  {(34, 36, 8, 41, 9, 21, 23, 27, 30), (10, 11, ...  \n",
       "...           ...                                                ...  \n",
       "55891           0  {(34, 37, 7, 40, 9, 42, 14, 16, 25), (35, 37, ...  \n",
       "55892           1  {(32, 34, 40, 13, 15, 25, 26, 27, 31), (36, 10...  \n",
       "55893           1  {(32, 36, 7, 40, 11, 14, 17, 20, 23), (32, 36,...  \n",
       "55894           1  {(34, 37, 8, 12, 45, 18, 21, 23, 25), (37, 40,...  \n",
       "55895           2  {(37, 39, 42, 13, 46, 15, 18, 20, 30), (34, 7,...  \n",
       "\n",
       "[55896 rows x 15 columns]"
      ]
     },
     "metadata": {},
     "output_type": "display_data"
    }
   ],
   "source": [
    "# Load the database of maze configurations as \"df\"\n",
    "df = pd.read_pickle('../maze_configuration_database.pkl')\n",
    "display(df)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "dac87ec0-6954-481b-9f88-afdd9970424b",
   "metadata": {},
   "source": [
    "##### &rArr; __Next steps__: To learn about searching the maze configuration database, check out [`Maze_Configuration_Database_Search.ipynb`](Maze_Configuration_Database_Search.ipynb)\n",
    "##### &rArr; __Next steps__: If you're interested in how the database was generated, check out [`Generate_Hex_Maze_Database.ipynb`](Generate_Hex_Maze_Database.ipynb)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "id": "4a114ce1-98aa-4fb7-9fe9-deba65b364d4",
   "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>barrier_sequence</th>\n",
       "      <th>sequence_length</th>\n",
       "      <th>reward_path_lengths</th>\n",
       "      <th>choice_points</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>[(37, 7, 39, 41, 14, 46, 20, 23, 30), (37, 39,...</td>\n",
       "      <td>5</td>\n",
       "      <td>[[15, 17, 21], [15, 21, 19], [15, 17, 19], [23...</td>\n",
       "      <td>[{13}, {26}, {26, 13, 29}, {29}, {13}]</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>[(34, 36, 37, 39, 10, 45, 14, 15, 20), (34, 37...</td>\n",
       "      <td>6</td>\n",
       "      <td>[[17, 21, 19], [19, 21, 17], [19, 15, 17], [17...</td>\n",
       "      <td>[{21}, {30}, {24}, {16, 24, 26}, {24}, {35}]</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>[(34, 7, 41, 11, 46, 17, 20, 28, 31)]</td>\n",
       "      <td>1</td>\n",
       "      <td>[[23, 19, 17]]</td>\n",
       "      <td>[{35}]</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>[(34, 10, 42, 12, 45, 18, 23, 25, 31), (34, 37...</td>\n",
       "      <td>6</td>\n",
       "      <td>[[15, 19, 21], [15, 19, 17], [21, 19, 15], [21...</td>\n",
       "      <td>[{17}, {17, 26, 35}, {35}, {24}, {24, 17, 26},...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>[(39, 9, 10, 46, 21, 22, 23, 26, 30)]</td>\n",
       "      <td>1</td>\n",
       "      <td>[[23, 17, 17]]</td>\n",
       "      <td>[{29}]</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>...</th>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>995</th>\n",
       "      <td>[(32, 34, 45, 13, 14, 15, 18, 19, 25), (32, 34...</td>\n",
       "      <td>2</td>\n",
       "      <td>[[19, 17, 15], [19, 15, 17]]</td>\n",
       "      <td>[{35}, {24}]</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>996</th>\n",
       "      <td>[(37, 7, 40, 13, 46, 45, 18, 25, 28), (37, 7, ...</td>\n",
       "      <td>2</td>\n",
       "      <td>[[15, 19, 17], [17, 19, 15]]</td>\n",
       "      <td>[{26}, {36}]</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>997</th>\n",
       "      <td>[(36, 10, 11, 46, 15, 21, 25, 27, 29)]</td>\n",
       "      <td>1</td>\n",
       "      <td>[[19, 15, 21]]</td>\n",
       "      <td>[{16}]</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>998</th>\n",
       "      <td>[(32, 8, 9, 41, 15, 20, 21, 27, 29), (32, 8, 9...</td>\n",
       "      <td>2</td>\n",
       "      <td>[[17, 21, 15], [17, 15, 21]]</td>\n",
       "      <td>[{31}, {13}]</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>999</th>\n",
       "      <td>[(9, 44, 46, 14, 20, 25, 26, 28, 30)]</td>\n",
       "      <td>1</td>\n",
       "      <td>[[23, 17, 17]]</td>\n",
       "      <td>[{29}]</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "<p>1000 rows × 4 columns</p>\n",
       "</div>"
      ],
      "text/plain": [
       "                                      barrier_sequence  sequence_length  \\\n",
       "0    [(37, 7, 39, 41, 14, 46, 20, 23, 30), (37, 39,...                5   \n",
       "1    [(34, 36, 37, 39, 10, 45, 14, 15, 20), (34, 37...                6   \n",
       "2                [(34, 7, 41, 11, 46, 17, 20, 28, 31)]                1   \n",
       "3    [(34, 10, 42, 12, 45, 18, 23, 25, 31), (34, 37...                6   \n",
       "4                [(39, 9, 10, 46, 21, 22, 23, 26, 30)]                1   \n",
       "..                                                 ...              ...   \n",
       "995  [(32, 34, 45, 13, 14, 15, 18, 19, 25), (32, 34...                2   \n",
       "996  [(37, 7, 40, 13, 46, 45, 18, 25, 28), (37, 7, ...                2   \n",
       "997             [(36, 10, 11, 46, 15, 21, 25, 27, 29)]                1   \n",
       "998  [(32, 8, 9, 41, 15, 20, 21, 27, 29), (32, 8, 9...                2   \n",
       "999              [(9, 44, 46, 14, 20, 25, 26, 28, 30)]                1   \n",
       "\n",
       "                                   reward_path_lengths  \\\n",
       "0    [[15, 17, 21], [15, 21, 19], [15, 17, 19], [23...   \n",
       "1    [[17, 21, 19], [19, 21, 17], [19, 15, 17], [17...   \n",
       "2                                       [[23, 19, 17]]   \n",
       "3    [[15, 19, 21], [15, 19, 17], [21, 19, 15], [21...   \n",
       "4                                       [[23, 17, 17]]   \n",
       "..                                                 ...   \n",
       "995                       [[19, 17, 15], [19, 15, 17]]   \n",
       "996                       [[15, 19, 17], [17, 19, 15]]   \n",
       "997                                     [[19, 15, 21]]   \n",
       "998                       [[17, 21, 15], [17, 15, 21]]   \n",
       "999                                     [[23, 17, 17]]   \n",
       "\n",
       "                                         choice_points  \n",
       "0               [{13}, {26}, {26, 13, 29}, {29}, {13}]  \n",
       "1         [{21}, {30}, {24}, {16, 24, 26}, {24}, {35}]  \n",
       "2                                               [{35}]  \n",
       "3    [{17}, {17, 26, 35}, {35}, {24}, {24, 17, 26},...  \n",
       "4                                               [{29}]  \n",
       "..                                                 ...  \n",
       "995                                       [{35}, {24}]  \n",
       "996                                       [{26}, {36}]  \n",
       "997                                             [{16}]  \n",
       "998                                       [{31}, {13}]  \n",
       "999                                             [{29}]  \n",
       "\n",
       "[1000 rows x 4 columns]"
      ]
     },
     "metadata": {},
     "output_type": "display_data"
    }
   ],
   "source": [
    "# Load the database of barrier sequences as \"barrier_df\"\n",
    "barrier_df = pd.read_pickle('../Barrier_Sequence_Databases/barrier_sequences_first1000.pkl')\n",
    "display(barrier_df)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "733a86e3-2394-47cf-95a6-6bffdaa4d2d0",
   "metadata": {},
   "source": [
    "##### &rArr; __Next steps__: To learn about searching the barrier sequence database, check out [`Barrier_Sequence_Database_Search.ipynb`](Barrier_Sequence_Database_Search.ipynb)\n",
    "##### &rArr; __Next steps__: If you're interested in generating barrier sequences with custom criteria, check out [`Generate_Custom_Barrier_Sequence_Database.ipynb`](Generate_Custom_Barrier_Sequence_Database.ipynb)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "259660e5-c122-40cb-a5c7-fef92a38f6c0",
   "metadata": {},
   "source": [
    "### Other functions\n",
    "`hex_maze_utils.py` provides lots of helpful functions for working with hex mazes. These functions can be imported for use in your notebooks. All functions provide documentation that can be accessed via `help(function_name)`"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "id": "5c1420c1-b69d-4e2c-97e7-8819242b8b4f",
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Help on function plot_hex_maze in module hex_maze_utils:\n",
      "\n",
      "plot_hex_maze(barriers=None, old_barrier=None, new_barrier=None, show_barriers=True, show_choice_points=True, show_optimal_paths=False, show_arrow=True, show_barrier_change=True, scale=1)\n",
      "    Given a set of barriers specifying a hex maze, plot the maze\n",
      "    in classic hex maze style.\n",
      "    Open hexes are shown in light blue. By default, barriers are shown\n",
      "    in black, and choice point(s) are shown in yellow.\n",
      "\n",
      "    Option to specify old_barrier hex and new_barrier hex\n",
      "    to indicate a barrier change configuration:\n",
      "    The now-open hex where the barrier used to be is shown in pale red.\n",
      "    The new barrier is shown in dark red. An arrow indicating the movement\n",
      "    of the barrier from the old hex to the new hex is shown in pink.\n",
      "\n",
      "    Args:\n",
      "    barriers (set of ints): A set defining the hexes where barriers are placed in the maze.         If no barriers or 'None' is specifed, plots an empty hex maze\n",
      "    old_barrier (int): Optional. The hex where the barrier was in the previous maze\n",
      "    new_barrier (int): Optional. The hex where the new barrier is in this maze\n",
      "\n",
      "    Additional args to change the plot style:\n",
      "    - show_barriers (bool): If the barriers should be shown as black hexes and labeled.     If False, only open hexes are shown. Defaults to True\n",
      "    - show_choice_points (bool): If the choice points should be shown in yellow.     If False, the choice points are not indicated on the plot. Defaults to True\n",
      "    - show_optimal_paths (bool): Highlight the hexes on optimal paths between     reward ports in light green. Defaults to False\n",
      "    - show_arrow (bool): Draw an arrow indicating barrier movement from the     old_barrier hex to the new_barrier hex. Defaults to True if old_barrier and     new_barrier are not None\n",
      "    - show_barrier_change (bool): Highlight the old_barrier and new_barrier hexes     on the maze. Defaults to True if old_barrier and new_barrier are not None.     Note that highlighting choice points takes precendence over barrier change     hexes, as they are also shown by the movement arrow. If show_barriers=False,     the new_barrier hex will not be shown (because no barriers are shown with this option.)\n",
      "\n",
      "Help on function get_barrier_change in module hex_maze_utils:\n",
      "\n",
      "get_barrier_change(maze_1, maze_2)\n",
      "    Given 2 mazes that differ by the movement of a single barrier,\n",
      "    find the barrier that was moved.\n",
      "\n",
      "    Args:\n",
      "    maze_1 (set/frozenset): Set of barriers representing the first hex maze\n",
      "    maze_2 (set/frozenset): Set of barriers representing the second hex maze\n",
      "\n",
      "    Returns:\n",
      "    old_barrier (int): The hex location of the barrier to be moved in the first set\n",
      "    new_barrier (int): The hex location the barrier was moved to in the second set\n",
      "\n"
     ]
    }
   ],
   "source": [
    "# Import some example functions from hex_maze_utils\n",
    "from hex_maze_utils import plot_hex_maze, get_barrier_change\n",
    "\n",
    "# View the documentation for these functions\n",
    "help(plot_hex_maze)\n",
    "\n",
    "help(get_barrier_change)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "387faa9c-9dd6-445d-bfa9-25a4139b3dff",
   "metadata": {},
   "source": [
    "##### &rArr; __Next steps__: For demos of useful hex maze functions, check out [`Hex_Maze_Functions.ipynb`](Hex_Maze_Functions.ipynb)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "4d0bf87f-feb7-4e1b-ad03-d7ec99718703",
   "metadata": {},
   "source": [
    "\n",
    "\n",
    "\n",
    "### Now you're ready to explore the other tutorials! Happy hex maze-ing!"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3 (ipykernel)",
   "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.12.3"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}