{
"cells": [
{
"cell_type": "markdown",
"id": "85e44075",
"metadata": {},
"source": [
"Getting started\n",
"===============\n",
"\n",
"Installation\n",
"------------\n",
"\n",
"Folium can be installed using\n",
"\n",
"```\n",
"$ pip install folium\n",
"```\n",
"\n",
"If you are using the Conda package manager, the equivalent is\n",
"\n",
"```\n",
"$ conda install folium -c conda-forge\n",
"```\n",
"\n",
"\n",
"### Dependencies\n",
"\n",
"Folium has the following dependencies, all of which are installed automatically\n",
"with the above installation commands:\n",
"\n",
"- branca\n",
"- Jinja2\n",
"- Numpy\n",
"- Requests\n",
"\n",
"Additional packages may be necessary for some functionality. It will say so in\n",
"the documentation where that's the case.\n",
"\n",
"\n",
"Creating a map\n",
"---------------\n",
"\n",
"Here's a basic example of creating a map:"
]
},
{
"cell_type": "code",
"execution_count": 1,
"id": "f9cf0161",
"metadata": {
"execution": {
"iopub.execute_input": "2024-02-29T08:58:59.159882Z",
"iopub.status.busy": "2024-02-29T08:58:59.159720Z",
"iopub.status.idle": "2024-02-29T08:58:59.558353Z",
"shell.execute_reply": "2024-02-29T08:58:59.557869Z"
}
},
"outputs": [],
"source": [
"import folium\n",
"\n",
"m = folium.Map(location=(45.5236, -122.6750))"
]
},
{
"cell_type": "markdown",
"id": "71a02cbb",
"metadata": {},
"source": [
"If you are in a Jupyter Notebook, you can display it by asking for the object representation:"
]
},
{
"cell_type": "code",
"execution_count": 2,
"id": "2562f91f",
"metadata": {
"execution": {
"iopub.execute_input": "2024-02-29T08:58:59.560516Z",
"iopub.status.busy": "2024-02-29T08:58:59.560251Z",
"iopub.status.idle": "2024-02-29T08:58:59.568518Z",
"shell.execute_reply": "2024-02-29T08:58:59.568129Z"
}
},
"outputs": [
{
"data": {
"text/html": [
"
Make this Notebook Trusted to load map: File -> Trust Notebook
"
],
"text/plain": [
""
]
},
"execution_count": 2,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"m"
]
},
{
"cell_type": "markdown",
"id": "83a83380",
"metadata": {},
"source": [
"Or you can save it as an HTML file:"
]
},
{
"cell_type": "code",
"execution_count": 3,
"id": "867e2dd9",
"metadata": {
"execution": {
"iopub.execute_input": "2024-02-29T08:58:59.570282Z",
"iopub.status.busy": "2024-02-29T08:58:59.569986Z",
"iopub.status.idle": "2024-02-29T08:58:59.574675Z",
"shell.execute_reply": "2024-02-29T08:58:59.574327Z"
}
},
"outputs": [],
"source": [
"m.save(\"index.html\")"
]
},
{
"cell_type": "markdown",
"id": "38ba69e2",
"metadata": {},
"source": [
"Choosing a tileset\n",
"------------------\n",
"\n",
"The default tiles are set to `OpenStreetMap`, but a selection of tilesets are also built in."
]
},
{
"cell_type": "code",
"execution_count": 4,
"id": "fd44e7d2",
"metadata": {
"execution": {
"iopub.execute_input": "2024-02-29T08:58:59.576289Z",
"iopub.status.busy": "2024-02-29T08:58:59.576129Z",
"iopub.status.idle": "2024-02-29T08:58:59.583835Z",
"shell.execute_reply": "2024-02-29T08:58:59.583473Z"
}
},
"outputs": [
{
"data": {
"text/html": [
"
Make this Notebook Trusted to load map: File -> Trust Notebook
"
],
"text/plain": [
""
]
},
"execution_count": 4,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"folium.Map((45.5236, -122.6750), tiles=\"cartodb positron\")"
]
},
{
"cell_type": "markdown",
"id": "ba0b2f43",
"metadata": {},
"source": [
"You can also pass any tileset as a url template. Choose one from https://leaflet-extras.github.io/leaflet-providers/preview/\n",
"and pass the url and attribution. For example:\n",
"\n",
"```\n",
"folium.Map(tiles='https://{s}.tiles.example.com/{z}/{x}/{y}.png', attr='My Data Attribution')\n",
"```\n",
"\n",
"Folium also accepts objects from the [xyzservices package](https://github.com/geopandas/xyzservices).\n",
"\n",
"\n",
"Adding markers\n",
"--------------\n",
"\n",
"There are various marker types, here we start with a simple `Marker`. You can add a popup and\n",
"tooltip. You can also pick colors and icons."
]
},
{
"cell_type": "code",
"execution_count": 5,
"id": "5785c978",
"metadata": {
"execution": {
"iopub.execute_input": "2024-02-29T08:58:59.585735Z",
"iopub.status.busy": "2024-02-29T08:58:59.585437Z",
"iopub.status.idle": "2024-02-29T08:58:59.596542Z",
"shell.execute_reply": "2024-02-29T08:58:59.596166Z"
}
},
"outputs": [
{
"data": {
"text/html": [
"
Make this Notebook Trusted to load map: File -> Trust Notebook
"
],
"text/plain": [
""
]
},
"execution_count": 5,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"m = folium.Map([45.35, -121.6972], zoom_start=12)\n",
"\n",
"folium.Marker(\n",
" location=[45.3288, -121.6625],\n",
" tooltip=\"Click me!\",\n",
" popup=\"Mt. Hood Meadows\",\n",
" icon=folium.Icon(icon=\"cloud\"),\n",
").add_to(m)\n",
"\n",
"folium.Marker(\n",
" location=[45.3311, -121.7113],\n",
" tooltip=\"Click me!\",\n",
" popup=\"Timberline Lodge\",\n",
" icon=folium.Icon(color=\"green\"),\n",
").add_to(m)\n",
"\n",
"m"
]
},
{
"cell_type": "markdown",
"id": "6ebcde77",
"metadata": {},
"source": [
"Vectors such as lines\n",
"---------------------\n",
"\n",
"Folium has various vector elements. One example is `PolyLine`, which can show linear elements on a map.\n",
"This object can help put emphasis on a trail, a road, or a coastline."
]
},
{
"cell_type": "code",
"execution_count": 6,
"id": "7c81ee84",
"metadata": {
"execution": {
"iopub.execute_input": "2024-02-29T08:58:59.598420Z",
"iopub.status.busy": "2024-02-29T08:58:59.598109Z",
"iopub.status.idle": "2024-02-29T08:58:59.606909Z",
"shell.execute_reply": "2024-02-29T08:58:59.606593Z"
}
},
"outputs": [
{
"data": {
"text/html": [
"
Make this Notebook Trusted to load map: File -> Trust Notebook
"
],
"text/plain": [
""
]
},
"execution_count": 6,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"m = folium.Map(location=[-71.38, -73.9], zoom_start=11)\n",
"\n",
"trail_coordinates = [\n",
" (-71.351871840295871, -73.655963711222626),\n",
" (-71.374144382613707, -73.719861619751498),\n",
" (-71.391042575973145, -73.784922248007007),\n",
" (-71.400964450973134, -73.851042243124397),\n",
" (-71.402411391077322, -74.050048183880477),\n",
"]\n",
"\n",
"folium.PolyLine(trail_coordinates, tooltip=\"Coast\").add_to(m)\n",
"\n",
"m"
]
},
{
"cell_type": "markdown",
"id": "9d47ec96",
"metadata": {},
"source": [
"Grouping and controlling\n",
"------------------------\n",
"\n",
"You can group multiple elements such as markers together in a `FeatureGroup`. You can select\n",
"which you want to show by adding a `LayerControl` to the map."
]
},
{
"cell_type": "code",
"execution_count": 7,
"id": "669671c8",
"metadata": {
"execution": {
"iopub.execute_input": "2024-02-29T08:58:59.608728Z",
"iopub.status.busy": "2024-02-29T08:58:59.608392Z",
"iopub.status.idle": "2024-02-29T08:58:59.620330Z",
"shell.execute_reply": "2024-02-29T08:58:59.619984Z"
}
},
"outputs": [
{
"data": {
"text/html": [
"
Make this Notebook Trusted to load map: File -> Trust Notebook