{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "0",
   "metadata": {},
   "source": [
    "# Minimum working example\n",
    "This notebook runs a minimum working example with growbikenet."
   ]
  },
  {
   "cell_type": "markdown",
   "id": "1",
   "metadata": {},
   "source": [
    "## Import growbikenet"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "66e59357-7987-4e0c-b5fa-8a261d3fedec",
   "metadata": {},
   "source": [
    "The standard way of importing growbikenet:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "2",
   "metadata": {},
   "outputs": [],
   "source": [
    "import growbikenet as gbn"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "3",
   "metadata": {},
   "source": [
    "## Run growbikenet on example city"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "4",
   "metadata": {},
   "outputs": [],
   "source": [
    "edges_ranked = gbn.growbikenet(\"Lyon\")"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "4a20e33e-3bfa-4578-b21e-83e0a0b5993b",
   "metadata": {},
   "source": [
    "## Explore results"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "039083d0-91f3-42cc-a377-9e555b25d6ca",
   "metadata": {},
   "source": [
    "See the contents of the resulting geodataframe:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "ec409ae0-4974-4ccb-984c-06c680a2c1a1",
   "metadata": {},
   "outputs": [],
   "source": [
    "edges_ranked.head()"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "bcd2409f-bac6-4e7c-89e9-d8c229eb36d2",
   "metadata": {},
   "source": [
    "Explore the results interactively:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "fac59916-d789-4e4d-8415-81dd962e8fbb",
   "metadata": {},
   "outputs": [],
   "source": [
    "edges_ranked.explore(tiles=\"CartoDB Positron\", # background map\n",
    "                     style_kwds={\"weight\": 4, \"color\": \"#096a51\"}, # thick green lines\n",
    "                    )"
   ]
  }
 ],
 "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.13"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}