examples/minimal.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "8e52c658-2cf1-447a-b02e-7f2bd4c0783d",
   "metadata": {},
   "source": [
    "# Minimal Example: Using TileZZ with Jupyter\n",
    "\n",
    "This notebook shows a minimal example of using tilezz with a Jupyter notebook."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 11,
   "id": "26104b49-b3ec-4363-8042-f427eeb6c49c",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/html": [
       "<div style=\"\"><svg width=\"500\" height=\"500\" viewBox=\"0 0 500 500\" xmlns=\"http://www.w3.org/2000/svg\">\n",
       "<rect x=\"0\" y=\"0\" width=\"500\" height=\"500\" opacity=\"1\" fill=\"#FFFFFF\" stroke=\"none\"/>\n",
       "<polygon opacity=\"0.2\" fill=\"#FFFF00\" points=\"410,309 410,230 342,191 274,152 206,191 167,123 88,123 88,202 156,241 117,309 156,377 224,338 292,377 331,309 410,309 410,309 410,309 \"/>\n",
       "<polyline fill=\"none\" opacity=\"1\" stroke=\"#000000\" stroke-width=\"1\" points=\"410,309 410,230 342,191 274,152 206,191 167,123 88,123 88,202 156,241 117,309 156,377 224,338 292,377 331,309 410,309 \"/>\n",
       "<circle cx=\"410\" cy=\"309\" r=\"10\" opacity=\"1\" fill=\"#FF0000\" stroke=\"none\" stroke-width=\"1\"/>\n",
       "<circle cx=\"410\" cy=\"230\" r=\"10\" opacity=\"1\" fill=\"#FF0000\" stroke=\"none\" stroke-width=\"1\"/>\n",
       "<circle cx=\"342\" cy=\"191\" r=\"10\" opacity=\"1\" fill=\"#FF0000\" stroke=\"none\" stroke-width=\"1\"/>\n",
       "<circle cx=\"274\" cy=\"152\" r=\"10\" opacity=\"1\" fill=\"#FF0000\" stroke=\"none\" stroke-width=\"1\"/>\n",
       "<circle cx=\"206\" cy=\"191\" r=\"10\" opacity=\"1\" fill=\"#FF0000\" stroke=\"none\" stroke-width=\"1\"/>\n",
       "<circle cx=\"167\" cy=\"123\" r=\"10\" opacity=\"1\" fill=\"#FF0000\" stroke=\"none\" stroke-width=\"1\"/>\n",
       "<circle cx=\"88\" cy=\"123\" r=\"10\" opacity=\"1\" fill=\"#FF0000\" stroke=\"none\" stroke-width=\"1\"/>\n",
       "<circle cx=\"88\" cy=\"202\" r=\"10\" opacity=\"1\" fill=\"#FF0000\" stroke=\"none\" stroke-width=\"1\"/>\n",
       "<circle cx=\"156\" cy=\"241\" r=\"10\" opacity=\"1\" fill=\"#FF0000\" stroke=\"none\" stroke-width=\"1\"/>\n",
       "<circle cx=\"117\" cy=\"309\" r=\"10\" opacity=\"1\" fill=\"#FF0000\" stroke=\"none\" stroke-width=\"1\"/>\n",
       "<circle cx=\"156\" cy=\"377\" r=\"10\" opacity=\"1\" fill=\"#FF0000\" stroke=\"none\" stroke-width=\"1\"/>\n",
       "<circle cx=\"224\" cy=\"338\" r=\"10\" opacity=\"1\" fill=\"#FF0000\" stroke=\"none\" stroke-width=\"1\"/>\n",
       "<circle cx=\"292\" cy=\"377\" r=\"10\" opacity=\"1\" fill=\"#FF0000\" stroke=\"none\" stroke-width=\"1\"/>\n",
       "<circle cx=\"331\" cy=\"309\" r=\"10\" opacity=\"1\" fill=\"#FF0000\" stroke=\"none\" stroke-width=\"1\"/>\n",
       "<circle cx=\"410\" cy=\"309\" r=\"10\" opacity=\"1\" fill=\"#FF0000\" stroke=\"none\" stroke-width=\"1\"/>\n",
       "<text x=\"410\" y=\"309\" dy=\"0.5ex\" text-anchor=\"middle\" font-family=\"sans-serif\" font-size=\"16.129032258064516\" opacity=\"1\" fill=\"#FFFFFF\" font-weight=\"bold\">\n",
       "\n",
       "</text>\n",
       "<text x=\"410\" y=\"230\" dy=\"0.5ex\" text-anchor=\"middle\" font-family=\"sans-serif\" font-size=\"16.129032258064516\" opacity=\"1\" fill=\"#FFFFFF\" font-weight=\"bold\">\n",
       "\n",
       "</text>\n",
       "<text x=\"342\" y=\"191\" dy=\"0.5ex\" text-anchor=\"middle\" font-family=\"sans-serif\" font-size=\"16.129032258064516\" opacity=\"1\" fill=\"#FFFFFF\" font-weight=\"bold\">\n",
       "\n",
       "</text>\n",
       "<text x=\"274\" y=\"152\" dy=\"0.5ex\" text-anchor=\"middle\" font-family=\"sans-serif\" font-size=\"16.129032258064516\" opacity=\"1\" fill=\"#FFFFFF\" font-weight=\"bold\">\n",
       "\n",
       "</text>\n",
       "<text x=\"206\" y=\"191\" dy=\"0.5ex\" text-anchor=\"middle\" font-family=\"sans-serif\" font-size=\"16.129032258064516\" opacity=\"1\" fill=\"#FFFFFF\" font-weight=\"bold\">\n",
       "\n",
       "</text>\n",
       "<text x=\"167\" y=\"123\" dy=\"0.5ex\" text-anchor=\"middle\" font-family=\"sans-serif\" font-size=\"16.129032258064516\" opacity=\"1\" fill=\"#FFFFFF\" font-weight=\"bold\">\n",
       "\n",
       "</text>\n",
       "<text x=\"88\" y=\"123\" dy=\"0.5ex\" text-anchor=\"middle\" font-family=\"sans-serif\" font-size=\"16.129032258064516\" opacity=\"1\" fill=\"#FFFFFF\" font-weight=\"bold\">\n",
       "\n",
       "</text>\n",
       "<text x=\"88\" y=\"202\" dy=\"0.5ex\" text-anchor=\"middle\" font-family=\"sans-serif\" font-size=\"16.129032258064516\" opacity=\"1\" fill=\"#FFFFFF\" font-weight=\"bold\">\n",
       "\n",
       "</text>\n",
       "<text x=\"156\" y=\"241\" dy=\"0.5ex\" text-anchor=\"middle\" font-family=\"sans-serif\" font-size=\"16.129032258064516\" opacity=\"1\" fill=\"#FFFFFF\" font-weight=\"bold\">\n",
       "\n",
       "</text>\n",
       "<text x=\"117\" y=\"309\" dy=\"0.5ex\" text-anchor=\"middle\" font-family=\"sans-serif\" font-size=\"16.129032258064516\" opacity=\"1\" fill=\"#FFFFFF\" font-weight=\"bold\">\n",
       "\n",
       "</text>\n",
       "<text x=\"156\" y=\"377\" dy=\"0.5ex\" text-anchor=\"middle\" font-family=\"sans-serif\" font-size=\"16.129032258064516\" opacity=\"1\" fill=\"#FFFFFF\" font-weight=\"bold\">\n",
       "\n",
       "</text>\n",
       "<text x=\"224\" y=\"338\" dy=\"0.5ex\" text-anchor=\"middle\" font-family=\"sans-serif\" font-size=\"16.129032258064516\" opacity=\"1\" fill=\"#FFFFFF\" font-weight=\"bold\">\n",
       "\n",
       "</text>\n",
       "<text x=\"292\" y=\"377\" dy=\"0.5ex\" text-anchor=\"middle\" font-family=\"sans-serif\" font-size=\"16.129032258064516\" opacity=\"1\" fill=\"#FFFFFF\" font-weight=\"bold\">\n",
       "\n",
       "</text>\n",
       "<text x=\"331\" y=\"309\" dy=\"0.5ex\" text-anchor=\"middle\" font-family=\"sans-serif\" font-size=\"16.129032258064516\" opacity=\"1\" fill=\"#FFFFFF\" font-weight=\"bold\">\n",
       "\n",
       "</text>\n",
       "<text x=\"410\" y=\"309\" dy=\"0.5ex\" text-anchor=\"middle\" font-family=\"sans-serif\" font-size=\"16.129032258064516\" opacity=\"1\" fill=\"#FFFFFF\" font-weight=\"bold\">\n",
       "\n",
       "</text>\n",
       "<text x=\"410\" y=\"309\" dy=\"0.5ex\" text-anchor=\"middle\" font-family=\"sans-serif\" font-size=\"12.903225806451614\" opacity=\"1\" fill=\"#0000FF\" font-weight=\"bold\">\n",
       "0\n",
       "</text>\n",
       "<text x=\"410\" y=\"230\" dy=\"0.5ex\" text-anchor=\"middle\" font-family=\"sans-serif\" font-size=\"12.903225806451614\" opacity=\"1\" fill=\"#0000FF\" font-weight=\"bold\">\n",
       "1\n",
       "</text>\n",
       "<text x=\"342\" y=\"191\" dy=\"0.5ex\" text-anchor=\"middle\" font-family=\"sans-serif\" font-size=\"12.903225806451614\" opacity=\"1\" fill=\"#0000FF\" font-weight=\"bold\">\n",
       "2\n",
       "</text>\n",
       "<text x=\"274\" y=\"152\" dy=\"0.5ex\" text-anchor=\"middle\" font-family=\"sans-serif\" font-size=\"12.903225806451614\" opacity=\"1\" fill=\"#0000FF\" font-weight=\"bold\">\n",
       "3\n",
       "</text>\n",
       "<text x=\"206\" y=\"191\" dy=\"0.5ex\" text-anchor=\"middle\" font-family=\"sans-serif\" font-size=\"12.903225806451614\" opacity=\"1\" fill=\"#0000FF\" font-weight=\"bold\">\n",
       "4\n",
       "</text>\n",
       "<text x=\"167\" y=\"123\" dy=\"0.5ex\" text-anchor=\"middle\" font-family=\"sans-serif\" font-size=\"12.903225806451614\" opacity=\"1\" fill=\"#0000FF\" font-weight=\"bold\">\n",
       "5\n",
       "</text>\n",
       "<text x=\"88\" y=\"123\" dy=\"0.5ex\" text-anchor=\"middle\" font-family=\"sans-serif\" font-size=\"12.903225806451614\" opacity=\"1\" fill=\"#0000FF\" font-weight=\"bold\">\n",
       "6\n",
       "</text>\n",
       "<text x=\"88\" y=\"202\" dy=\"0.5ex\" text-anchor=\"middle\" font-family=\"sans-serif\" font-size=\"12.903225806451614\" opacity=\"1\" fill=\"#0000FF\" font-weight=\"bold\">\n",
       "7\n",
       "</text>\n",
       "<text x=\"156\" y=\"241\" dy=\"0.5ex\" text-anchor=\"middle\" font-family=\"sans-serif\" font-size=\"12.903225806451614\" opacity=\"1\" fill=\"#0000FF\" font-weight=\"bold\">\n",
       "8\n",
       "</text>\n",
       "<text x=\"117\" y=\"309\" dy=\"0.5ex\" text-anchor=\"middle\" font-family=\"sans-serif\" font-size=\"12.903225806451614\" opacity=\"1\" fill=\"#0000FF\" font-weight=\"bold\">\n",
       "9\n",
       "</text>\n",
       "<text x=\"156\" y=\"377\" dy=\"0.5ex\" text-anchor=\"middle\" font-family=\"sans-serif\" font-size=\"12.903225806451614\" opacity=\"1\" fill=\"#0000FF\" font-weight=\"bold\">\n",
       "10\n",
       "</text>\n",
       "<text x=\"224\" y=\"338\" dy=\"0.5ex\" text-anchor=\"middle\" font-family=\"sans-serif\" font-size=\"12.903225806451614\" opacity=\"1\" fill=\"#0000FF\" font-weight=\"bold\">\n",
       "11\n",
       "</text>\n",
       "<text x=\"292\" y=\"377\" dy=\"0.5ex\" text-anchor=\"middle\" font-family=\"sans-serif\" font-size=\"12.903225806451614\" opacity=\"1\" fill=\"#0000FF\" font-weight=\"bold\">\n",
       "12\n",
       "</text>\n",
       "<text x=\"331\" y=\"309\" dy=\"0.5ex\" text-anchor=\"middle\" font-family=\"sans-serif\" font-size=\"12.903225806451614\" opacity=\"1\" fill=\"#0000FF\" font-weight=\"bold\">\n",
       "13\n",
       "</text>\n",
       "</svg>\n",
       "</div>"
      ]
     },
     "execution_count": 11,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "// Build and load the crate\n",
    ":dep plotters = { version = \"^0.3.7\", features = [\"evcxr\", \"all_series\"] }\n",
    "// 1(a) if you want to use a published version of this crate:\n",
    "// :dep tilezz = \"*\"\n",
    "// 1(b) (RECOMMENDED) if you cloned this repository and want to use the current development version:\n",
    ":dep tilezz = { path = \"..\" }\n",
    "\n",
    "// Import what we need\n",
    "use tilezz::cyclotomic::*;\n",
    "use tilezz::snake::Turtle;\n",
    "use tilezz::rat::Rat;\n",
    "\n",
    "use plotters::prelude::*;\n",
    "use tilezz::vis::plotters::{plot_tile, TileStyle};\n",
    "\n",
    "evcxr_figure((500,500), |root| {\n",
    "    // Prepare the canvas\n",
    "    let _ = root.fill(&WHITE);\n",
    "    let root = root.margin(10, 10, 10, 10);\n",
    "\n",
    "    // Define a sequence of external angles. As all segments have unit length, this fully determines a polygon\n",
    "    let external_angles: &[i8] = &[3, 2, 0, 2, -3, 2, 3, 2, -3, 2, 3, -2, 3, -2];\n",
    "    // Instantiate an abstract polygon over the cyclotomic ring ZZ12 (one full turn = 12 rotational unit steps)\n",
    "    let r: Rat<ZZ12> = external_angles.try_into().unwrap();\n",
    "    // Trace out the polygon in the cartesian plane using a canonical starting point and facing direction\n",
    "    let p = r.to_polyline_f64(Turtle::default());\n",
    "    // Plot the concretized polygon with default settings\n",
    "    plot_tile(&root, &p, &TileStyle::default());\n",
    "    \n",
    "    Ok(())\n",
    "})"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "757d0420-418f-4580-b915-9084c9d717ab",
   "metadata": {},
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Rust",
   "language": "rust",
   "name": "rust"
  },
  "language_info": {
   "codemirror_mode": "rust",
   "file_extension": ".rs",
   "mimetype": "text/rust",
   "name": "Rust",
   "pygment_lexer": "rust",
   "version": ""
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}