npm - @basemaps/landing - Versions diffs - 6.45.0 → 7.0.0 - Mend

@basemaps/landing 6.45.0 → 7.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (96) hide show

package/dist/docs/index.html ADDED Viewed

@@ -0,0 +1,1141 @@
+<!doctype html>
+<html lang="en" class="no-js">
+  <head>
+      <meta charset="utf-8">
+      <meta name="viewport" content="width=device-width,initial-scale=1">
+        <link rel="canonical" href="http://localhost:8000/docs/">
+        <link rel="next" href="configuration/">
+      <link rel="icon" href="assets/images/favicon.png">
+      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.4.14">
+        <title>LINZ Basemaps</title>
+      <link rel="stylesheet" href="assets/stylesheets/main.fad675c6.min.css">
+        <link rel="stylesheet" href="assets/stylesheets/palette.356b1318.min.css">
+        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300i,400,400i,700,700i%7COpen+Sans+Mono:400,400i,700,700i&display=fallback">
+        <style>:root{--md-text-font:"Open Sans";--md-code-font:"Open Sans Mono"}</style>
+      <link rel="stylesheet" href="index.css">
+    <script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+<script id="__analytics">function __md_analytics(){function n(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],n("js",new Date),n("config",""),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&n("event","search",{search_term:this.value})}),document$.subscribe(function(){var a=document.forms.feedback;if(void 0!==a)for(var e of a.querySelectorAll("[type=submit]"))e.addEventListener("click",function(e){e.preventDefault();var t=document.location.pathname,e=this.getAttribute("data-md-value");n("event","feedback",{page:t,data:e}),a.firstElementChild.disabled=!0;e=a.querySelector(".md-feedback__note [data-md-value='"+e+"']");e&&(e.hidden=!1)}),a.hidden=!1}),location$.subscribe(function(e){n("config","",{page_path:e.pathname})})});var e=document.createElement("script");e.async=!0,e.src="https://www.googletagmanager.com/gtag/js?id=",document.getElementById("__analytics").insertAdjacentElement("afterEnd",e)}</script>
+    <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
+  </head>
+    <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
+      <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
+    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
+    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
+    <label class="md-overlay" for="__drawer"></label>
+    <div data-md-component="skip">
+        <a href="#linz-basemaps" class="md-skip">
+          Skip to content
+        </a>
+    </div>
+    <div data-md-component="announce">
+    </div>
+<header class="md-header md-header--shadow" data-md-component="header">
+  <nav class="md-header__inner md-grid" aria-label="Header">
+    <a href="." title="LINZ Basemaps" class="md-header__button md-logo" aria-label="LINZ Basemaps" data-md-component="logo">
+  <img src="linz-motif.svg" alt="logo">
+    </a>
+    <label class="md-header__button md-icon" for="__drawer">
+      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
+    </label>
+    <div class="md-header__title" data-md-component="header-title">
+      <div class="md-header__ellipsis">
+        <div class="md-header__topic">
+          <span class="md-ellipsis">
+            LINZ Basemaps
+          </span>
+        </div>
+        <div class="md-header__topic" data-md-component="header-topic">
+          <span class="md-ellipsis">
+              LINZ Basemaps
+          </span>
+        </div>
+      </div>
+    </div>
+        <form class="md-header__option" data-md-component="palette">
+    <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo"  aria-label="Switch to dark mode"  type="radio" name="__palette" id="__palette_1">
+      <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+      </label>
+    <input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo"  aria-label="Switch to light mode"  type="radio" name="__palette" id="__palette_2">
+      <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
+      </label>
+</form>
+      <label class="md-header__button md-icon" for="__search">
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
+      </label>
+      <div class="md-search" data-md-component="search" role="dialog">
+  <label class="md-search__overlay" for="__search"></label>
+  <div class="md-search__inner" role="search">
+    <form class="md-search__form" name="search">
+      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
+      <label class="md-search__icon md-icon" for="__search">
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
+      </label>
+      <nav class="md-search__options" aria-label="Search">
+        <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
+        </button>
+      </nav>
+    </form>
+    <div class="md-search__output">
+      <div class="md-search__scrollwrap" data-md-scrollfix>
+        <div class="md-search-result" data-md-component="search-result">
+          <div class="md-search-result__meta">
+            Initializing search
+          </div>
+          <ol class="md-search-result__list" role="presentation"></ol>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>
+      <div class="md-header__source">
+        <a href="https://github.com/linz/basemaps" title="Go to repository" class="md-source" data-md-component="source">
+  <div class="md-source__icon md-icon">
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
+  </div>
+  <div class="md-source__repository">
+    GitHub
+  </div>
+</a>
+      </div>
+  </nav>
+</header>
+    <div class="md-container" data-md-component="container">
+      <main class="md-main" data-md-component="main">
+        <div class="md-main__inner md-grid">
+              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
+                <div class="md-sidebar__scrollwrap">
+                  <div class="md-sidebar__inner">
+<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
+  <label class="md-nav__title" for="__drawer">
+    <a href="." title="LINZ Basemaps" class="md-nav__button md-logo" aria-label="LINZ Basemaps" data-md-component="logo">
+  <img src="linz-motif.svg" alt="logo">
+    </a>
+    LINZ Basemaps
+  </label>
+    <div class="md-nav__source">
+      <a href="https://github.com/linz/basemaps" title="Go to repository" class="md-source" data-md-component="source">
+  <div class="md-source__icon md-icon">
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
+  </div>
+  <div class="md-source__repository">
+    GitHub
+  </div>
+</a>
+    </div>
+  <ul class="md-nav__list" data-md-scrollfix>
+    <li class="md-nav__item md-nav__item--active">
+      <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
+        <label class="md-nav__link md-nav__link--active" for="__toc">
+  <span class="md-ellipsis">
+    LINZ Basemaps
+  </span>
+          <span class="md-nav__icon md-icon"></span>
+        </label>
+      <a href="." class="md-nav__link md-nav__link--active">
+  <span class="md-ellipsis">
+    LINZ Basemaps
+  </span>
+      </a>
+<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+    <label class="md-nav__title" for="__toc">
+      <span class="md-nav__icon md-icon"></span>
+      Table of contents
+    </label>
+    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
+        <li class="md-nav__item">
+  <a href="#background" class="md-nav__link">
+    <span class="md-ellipsis">
+      Background
+    </span>
+  </a>
+</li>
+        <li class="md-nav__item">
+  <a href="#basemaps-service" class="md-nav__link">
+    <span class="md-ellipsis">
+      Basemaps Service
+    </span>
+  </a>
+    <nav class="md-nav" aria-label="Basemaps Service">
+      <ul class="md-nav__list">
+          <li class="md-nav__item">
+  <a href="#imagery-tile-requests" class="md-nav__link">
+    <span class="md-ellipsis">
+      Imagery Tile Requests
+    </span>
+  </a>
+</li>
+          <li class="md-nav__item">
+  <a href="#vector-tile-requests" class="md-nav__link">
+    <span class="md-ellipsis">
+      Vector tile requests
+    </span>
+  </a>
+</li>
+          <li class="md-nav__item">
+  <a href="#additional-processing" class="md-nav__link">
+    <span class="md-ellipsis">
+      Additional Processing
+    </span>
+  </a>
+    <nav class="md-nav" aria-label="Additional Processing">
+      <ul class="md-nav__list">
+          <li class="md-nav__item">
+  <a href="#aerial-satellite-imagery-processing" class="md-nav__link">
+    <span class="md-ellipsis">
+      Aerial &amp; Satellite Imagery Processing
+    </span>
+  </a>
+</li>
+          <li class="md-nav__item">
+  <a href="#vector-data" class="md-nav__link">
+    <span class="md-ellipsis">
+      Vector Data
+    </span>
+  </a>
+</li>
+      </ul>
+    </nav>
+</li>
+      </ul>
+    </nav>
+</li>
+        <li class="md-nav__item">
+  <a href="#development" class="md-nav__link">
+    <span class="md-ellipsis">
+      Development
+    </span>
+  </a>
+    <nav class="md-nav" aria-label="Development">
+      <ul class="md-nav__list">
+          <li class="md-nav__item">
+  <a href="#diagrams" class="md-nav__link">
+    <span class="md-ellipsis">
+      Diagrams
+    </span>
+  </a>
+</li>
+      </ul>
+    </nav>
+</li>
+    </ul>
+</nav>
+    </li>
+    <li class="md-nav__item">
+      <a href="configuration/" class="md-nav__link">
+  <span class="md-ellipsis">
+    Configuration
+  </span>
+      </a>
+    </li>
+    <li class="md-nav__item">
+      <a href="deployment/" class="md-nav__link">
+  <span class="md-ellipsis">
+    Deployment
+  </span>
+      </a>
+    </li>
+    <li class="md-nav__item">
+      <a href="quick-start/" class="md-nav__link">
+  <span class="md-ellipsis">
+    Quick start guide
+  </span>
+      </a>
+    </li>
+    <li class="md-nav__item md-nav__item--nested">
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
+          <div class="md-nav__link md-nav__container">
+            <a href="developer-guide/" class="md-nav__link ">
+  <span class="md-ellipsis">
+    Developer guide
+  </span>
+            </a>
+          </div>
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_5">
+            <span class="md-nav__icon md-icon"></span>
+            Developer guide
+          </label>
+          <ul class="md-nav__list" data-md-scrollfix>
+          </ul>
+        </nav>
+    </li>
+    <li class="md-nav__item md-nav__item--nested">
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
+          <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
+  <span class="md-ellipsis">
+    Examples
+  </span>
+            <span class="md-nav__icon md-icon"></span>
+          </label>
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_6">
+            <span class="md-nav__icon md-icon"></span>
+            Examples
+          </label>
+          <ul class="md-nav__list" data-md-scrollfix>
+    <li class="md-nav__item">
+      <a href="examples/_overview/" class="md-nav__link">
+  <span class="md-ellipsis">
+    Overview
+  </span>
+      </a>
+    </li>
+    <li class="md-nav__item">
+      <a href="examples/leaflet.xyz.3857/" class="md-nav__link">
+  <span class="md-ellipsis">
+    Leaflet Raster Map
+  </span>
+      </a>
+    </li>
+    <li class="md-nav__item">
+      <a href="examples/maplibre.opacity.3857/" class="md-nav__link">
+  <span class="md-ellipsis">
+    Maplibre Opacity Slider
+  </span>
+      </a>
+    </li>
+    <li class="md-nav__item">
+      <a href="examples/maplibre.vector.3857/" class="md-nav__link">
+  <span class="md-ellipsis">
+    Maplibre Vector Map
+  </span>
+      </a>
+    </li>
+          </ul>
+        </nav>
+    </li>
+    <li class="md-nav__item md-nav__item--nested">
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
+          <div class="md-nav__link md-nav__container">
+            <a href="operator-guide/" class="md-nav__link ">
+  <span class="md-ellipsis">
+    Operator guide
+  </span>
+            </a>
+              <label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="0">
+                <span class="md-nav__icon md-icon"></span>
+              </label>
+          </div>
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_7">
+            <span class="md-nav__icon md-icon"></span>
+            Operator guide
+          </label>
+          <ul class="md-nav__list" data-md-scrollfix>
+    <li class="md-nav__item">
+      <a href="operator-guide/cog-quality/" class="md-nav__link">
+  <span class="md-ellipsis">
+    COG Quality
+  </span>
+      </a>
+    </li>
+    <li class="md-nav__item">
+      <a href="operator-guide/empty-tiles/" class="md-nav__link">
+  <span class="md-ellipsis">
+    Sparse Datasets and empty tiles
+  </span>
+      </a>
+    </li>
+    <li class="md-nav__item">
+      <a href="operator-guide/quick-start/" class="md-nav__link">
+  <span class="md-ellipsis">
+    Running LINZ Basemaps - Quick Start
+  </span>
+      </a>
+    </li>
+    <li class="md-nav__item">
+      <a href="operator-guide/relief-shade/" class="md-nav__link">
+  <span class="md-ellipsis">
+    Relief shade
+  </span>
+      </a>
+    </li>
+    <li class="md-nav__item">
+      <a href="operator-guide/texture-shade/" class="md-nav__link">
+  <span class="md-ellipsis">
+    Texture shading
+  </span>
+      </a>
+    </li>
+          </ul>
+        </nav>
+    </li>
+    <li class="md-nav__item md-nav__item--nested">
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" >
+          <div class="md-nav__link md-nav__container">
+            <a href="user-guide/" class="md-nav__link ">
+  <span class="md-ellipsis">
+    User guide
+  </span>
+            </a>
+          </div>
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_8">
+            <span class="md-nav__icon md-icon"></span>
+            User guide
+          </label>
+          <ul class="md-nav__list" data-md-scrollfix>
+          </ul>
+        </nav>
+    </li>
+  </ul>
+</nav>
+                  </div>
+                </div>
+              </div>
+              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
+                <div class="md-sidebar__scrollwrap">
+                  <div class="md-sidebar__inner">
+<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+    <label class="md-nav__title" for="__toc">
+      <span class="md-nav__icon md-icon"></span>
+      Table of contents
+    </label>
+    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
+        <li class="md-nav__item">
+  <a href="#background" class="md-nav__link">
+    <span class="md-ellipsis">
+      Background
+    </span>
+  </a>
+</li>
+        <li class="md-nav__item">
+  <a href="#basemaps-service" class="md-nav__link">
+    <span class="md-ellipsis">
+      Basemaps Service
+    </span>
+  </a>
+    <nav class="md-nav" aria-label="Basemaps Service">
+      <ul class="md-nav__list">
+          <li class="md-nav__item">
+  <a href="#imagery-tile-requests" class="md-nav__link">
+    <span class="md-ellipsis">
+      Imagery Tile Requests
+    </span>
+  </a>
+</li>
+          <li class="md-nav__item">
+  <a href="#vector-tile-requests" class="md-nav__link">
+    <span class="md-ellipsis">
+      Vector tile requests
+    </span>
+  </a>
+</li>
+          <li class="md-nav__item">
+  <a href="#additional-processing" class="md-nav__link">
+    <span class="md-ellipsis">
+      Additional Processing
+    </span>
+  </a>
+    <nav class="md-nav" aria-label="Additional Processing">
+      <ul class="md-nav__list">
+          <li class="md-nav__item">
+  <a href="#aerial-satellite-imagery-processing" class="md-nav__link">
+    <span class="md-ellipsis">
+      Aerial &amp; Satellite Imagery Processing
+    </span>
+  </a>
+</li>
+          <li class="md-nav__item">
+  <a href="#vector-data" class="md-nav__link">
+    <span class="md-ellipsis">
+      Vector Data
+    </span>
+  </a>
+</li>
+      </ul>
+    </nav>
+</li>
+      </ul>
+    </nav>
+</li>
+        <li class="md-nav__item">
+  <a href="#development" class="md-nav__link">
+    <span class="md-ellipsis">
+      Development
+    </span>
+  </a>
+    <nav class="md-nav" aria-label="Development">
+      <ul class="md-nav__list">
+          <li class="md-nav__item">
+  <a href="#diagrams" class="md-nav__link">
+    <span class="md-ellipsis">
+      Diagrams
+    </span>
+  </a>
+</li>
+      </ul>
+    </nav>
+</li>
+    </ul>
+</nav>
+                  </div>
+                </div>
+              </div>
+            <div class="md-content" data-md-component="content">
+              <article class="md-content__inner md-typeset">
+<h1 id="linz-basemaps">LINZ Basemaps</h1>
+<p><a href="https://basemaps.linz.govt.nz">LINZ Basemaps</a> is a collection of tools to create and serve vector and raster basemaps using open source and open standards. It is designed to be light weight, cost efficient and fast.</p>
+<p>Basemaps currently supports both <a href="#aerial--satellite-imagery">Imagery</a> and <a href="#vector-data">Vector data</a></p>
+<h2 id="background">Background</h2>
+<p>Land Information New Zealand has a large archive of aerial and satellite imagery freely available from <a href="https://data.linz.govt.nz">LINZ Data Service</a> and the <a href="https://registry.opendata.aws/nz-imagery/">Registry of Open Data on AWS</a>. This imagery was a primary driver for the creation of the LINZ Basemaps product and service. For more information on how LINZ acquires, ingests and publishes aerial and satellite imagery see <a href="https://github.com/linz/imagery">linz/imagery</a>.</p>
+<p>While linz/basemaps is public, its primary reason is to <a href="https://www.digital.govt.nz/standards-and-guidance/digital-service-design-standard/principles/work-in-the-open/">work in the open</a>, so that we can share knowledge and foster collaboration with peers across the world. While the LINZ Basemaps product and services can be customised and deployed we are primarily focused on our own use cases of sharing New Zealand's Aerial Imagery archive and Topographic vector data.</p>
+<h2 id="basemaps-service">Basemaps Service</h2>
+<p><img alt="Basemaps" src="static/basemaps-service.png" /> The core of the LINZ Basemaps Service consists of</p>
+<ul>
+<li>AWS S3 - COG Storage location</li>
+<li>AWS Lambda function - Tile Server - <a href="../packages/lambda-tiler/README.md">@basemaps/lambda-tiler</a></li>
+<li>AWS Cloudfront - Content distribution and tile cache</li>
+<li><a href="https://github.com/linz/basemaps">linz/basemaps-config</a> - Basemaps configuration</li>
+</ul>
+<h3 id="imagery-tile-requests">Imagery Tile Requests</h3>
+<p>A tile request flows a number of basemaps packages:</p>
+<p>Given a request <code>/v1/tiles/aerial/WebMercatorQuad/6/1/40.webp</code>,
+Breaking down this request url <code>lambda-tiler</code> needs to serve a <code>webp</code> image that for the tile <code>{z: 6, x: 1, y: 40}</code> from the <code>WebMercatorQuad</code> tile matrix from the tile set named <code>aerial</code> in the default configuration.</p>
+<p>Which will then utlize the following packages</p>
+<ul>
+<li><a href="../packages/config/README.md">@basemaps/config</a> - Load configuration (<a href="configuration/"><code>?config</code></a>)</li>
+<li><a href="../packages/lambda-tiler/README.md">@basemaps/lambda-tiler</a> Convert tile XYZ into output coordinates bounding box</li>
+<li><a href="../packages/lambda-tiler/README.md">@basemaps/lambda-tiler</a> Determine which tiffs intersect the output coordinates</li>
+<li><a href="../packages/tiler/README.md">@basemaps/tiler</a> Determine which parts of the tiffs need to be loaded and resampled</li>
+<li><a href="../packages/tiler-sharp/README.md">@basemaps/tiler-sharp</a> - Load the bytes from the tiff and render it as a output image.</li>
+</ul>
+<p>Imagery is stored as cloud optimised geotiffs by survey then layered together dynamically based on a <a href="configuration/">configured priority order</a>.</p>
+<p><a href="../packages/tiler/README.md">@basemaps/tiler</a> takes the collection of tiffs and determines how resample (resize/crop) and paint them onto the output tile.</p>
+<p><img alt="Tiff Operations" src="static/tile-resize.png" /></p>
+<p><a href="../packages/tiler-sharp/README.md">@basemaps/tiler-sharp</a> uses <a href="https://github.com/lovell/sharp">sharp/libvips</a> to take the output of <a href="../packages/tiler/README.md">@basemaps/tiler</a> then load the raw tiff bytes and render them into output image.</p>
+<h3 id="vector-tile-requests">Vector tile requests</h3>
+<p>Vector tiles are pre-rendered as <a href="https://docs.mapbox.com/data/tilesets/guides/vector-tiles-introduction/">Mapbox Vector Tiles</a> and served directly from a <a href="https://github.com/linz/cotar">Cloud Optimised Tar</a>. Since there is no merging or dynamic configuration the tile server will just request the specified tile directly from the tar file.</p>
+<h3 id="additional-processing">Additional Processing</h3>
+<h4 id="aerial-satellite-imagery-processing">Aerial &amp; Satellite Imagery Processing</h4>
+<p>To efficiently serve aerial imagery to huge number of consumers, it should be optimised into a format that makes it easy to serve. All of LINZ's imagery is stored as <a href="https://www.cogeo.org/">Cloud Optimised GeoTIFFs (COGs)</a>, and to ensure they are served as efficiently as possible some additional processing steps are generally pre-applied to the imagery.</p>
+<ul>
+<li><strong>Reprojection</strong>: reprojecting the imagery into common consumption formats (EPSG:3857 and EPSG:2193) will greatly reduce the amount of load and complexity of the basemaps service service</li>
+<li><strong>Tile Alignment</strong>: By aligning the COGs to the output XYZ tile grid</li>
+<li><strong>Additional overviews</strong>: It is hard to fetch data from 1,000s of COGs to create a single tile, so we create additional overviews up to z0.</li>
+</ul>
+<p>These additional processing steps are part of the basemaps <a href="#TODO">import process</a> and are controlled by <a href="../packages/cogify/README.md">@basemaps/cogify</a></p>
+<p>The additional steps are optional but do <strong>greatly improve</strong> the tile serving performance of the service.</p>
+<h4 id="vector-data">Vector Data</h4>
+<p>Vector data is processed from the LINZ topographic vector datasets using tippecanoe, this process is still a work in progress and will.</p>
+<h2 id="development">Development</h2>
+<p>Deployments are handled by Github Actions see <a href="deployment/">Deployments</a> for more information.</p>
+<h3 id="diagrams">Diagrams</h3>
+<p>All diagrams across this repository are created with <a href="https://excalidraw.com/">excalidraw</a> and embed the excalidraw configuration inside them, so can be re-edited on <a href="https://excalidraw.com/">excalidraw</a></p>
+              </article>
+            </div>
+        </div>
+      </main>
+        <footer class="md-footer">
+  <div class="md-footer-meta md-typeset">
+    <div class="md-footer-meta__inner md-grid">
+      <div class="md-copyright">
+    <div class="md-copyright__highlight">
+      <a href="https://www.linz.govt.nz/copyright">© CC BY 4.0 LINZ</a>
+    </div>
+    Made with
+    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
+      Material for MkDocs
+    </a>
+</div>
+    </div>
+  </div>
+</footer>
+    </div>
+    <div class="md-dialog" data-md-component="dialog">
+      <div class="md-dialog__inner md-typeset"></div>
+    </div>
+    <script id="__config" type="application/json">{"base": ".", "features": ["navigation.indexes", "content.code.copy"], "search": "assets/javascripts/workers/search.f886a092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
+      <script src="assets/javascripts/bundle.cd18aaf1.min.js"></script>
+  </body>
+</html>