A loose federation of distributed, typed datasets
1<!DOCTYPE html>
2<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
3
4<meta charset="utf-8">
5<meta name="generator" content="quarto-1.7.34">
6
7<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
8
9<meta name="description" content="Migrate datasets from local storage to ATProto">
10
11<title>Promotion Workflow – atdata</title>
12<style>
13code{white-space: pre-wrap;}
14span.smallcaps{font-variant: small-caps;}
15div.columns{display: flex; gap: min(4vw, 1.5em);}
16div.column{flex: auto; overflow-x: auto;}
17div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
18ul.task-list{list-style: none;}
19ul.task-list li input[type="checkbox"] {
20 width: 0.8em;
21 margin: 0 0.8em 0.2em -1em; /* quarto-specific, see https://github.com/quarto-dev/quarto-cli/issues/4556 */
22 vertical-align: middle;
23}
24/* CSS for syntax highlighting */
25html { -webkit-text-size-adjust: 100%; }
26pre > code.sourceCode { white-space: pre; position: relative; }
27pre > code.sourceCode > span { display: inline-block; line-height: 1.25; }
28pre > code.sourceCode > span:empty { height: 1.2em; }
29.sourceCode { overflow: visible; }
30code.sourceCode > span { color: inherit; text-decoration: inherit; }
31div.sourceCode { margin: 1em 0; }
32pre.sourceCode { margin: 0; }
33@media screen {
34div.sourceCode { overflow: auto; }
35}
36@media print {
37pre > code.sourceCode { white-space: pre-wrap; }
38pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; }
39}
40pre.numberSource code
41 { counter-reset: source-line 0; }
42pre.numberSource code > span
43 { position: relative; left: -4em; counter-increment: source-line; }
44pre.numberSource code > span > a:first-child::before
45 { content: counter(source-line);
46 position: relative; left: -1em; text-align: right; vertical-align: baseline;
47 border: none; display: inline-block;
48 -webkit-touch-callout: none; -webkit-user-select: none;
49 -khtml-user-select: none; -moz-user-select: none;
50 -ms-user-select: none; user-select: none;
51 padding: 0 4px; width: 4em;
52 }
53pre.numberSource { margin-left: 3em; padding-left: 4px; }
54div.sourceCode
55 { }
56@media screen {
57pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }
58}
59</style>
60
61
62<script src="../site_libs/quarto-nav/quarto-nav.js"></script>
63<script src="../site_libs/quarto-nav/headroom.min.js"></script>
64<script src="../site_libs/clipboard/clipboard.min.js"></script>
65<script src="../site_libs/quarto-search/autocomplete.umd.js"></script>
66<script src="../site_libs/quarto-search/fuse.min.js"></script>
67<script src="../site_libs/quarto-search/quarto-search.js"></script>
68<meta name="quarto:offset" content="../">
69<script src="../site_libs/quarto-html/quarto.js" type="module"></script>
70<script src="../site_libs/quarto-html/tabsets/tabsets.js" type="module"></script>
71<script src="../site_libs/quarto-html/popper.min.js"></script>
72<script src="../site_libs/quarto-html/tippy.umd.min.js"></script>
73<script src="../site_libs/quarto-html/anchor.min.js"></script>
74<link href="../site_libs/quarto-html/tippy.css" rel="stylesheet">
75<link href="../site_libs/quarto-html/quarto-syntax-highlighting-9582434199d49cc9e91654cdeeb4866b.css" rel="stylesheet" class="quarto-color-scheme" id="quarto-text-highlighting-styles">
76<link href="../site_libs/quarto-html/quarto-syntax-highlighting-dark-8dcd8563ea6803ab7cbb3d71ca5772e1.css" rel="stylesheet" class="quarto-color-scheme quarto-color-alternate" id="quarto-text-highlighting-styles">
77<link href="../site_libs/quarto-html/quarto-syntax-highlighting-9582434199d49cc9e91654cdeeb4866b.css" rel="stylesheet" class="quarto-color-scheme-extra" id="quarto-text-highlighting-styles">
78<script src="../site_libs/bootstrap/bootstrap.min.js"></script>
79<link href="../site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
80<link href="../site_libs/bootstrap/bootstrap-62bce24ca844314e7bb1a34dbdfe05cc.min.css" rel="stylesheet" append-hash="true" class="quarto-color-scheme" id="quarto-bootstrap" data-mode="light">
81<link href="../site_libs/bootstrap/bootstrap-dark-7964ffd8887b0991fe8d71c6c8bc75d6.min.css" rel="stylesheet" append-hash="true" class="quarto-color-scheme quarto-color-alternate" id="quarto-bootstrap" data-mode="dark">
82<link href="../site_libs/bootstrap/bootstrap-62bce24ca844314e7bb1a34dbdfe05cc.min.css" rel="stylesheet" append-hash="true" class="quarto-color-scheme-extra" id="quarto-bootstrap" data-mode="light">
83<script id="quarto-search-options" type="application/json">{
84 "location": "navbar",
85 "copy-button": false,
86 "collapse-after": 3,
87 "panel-placement": "end",
88 "type": "overlay",
89 "limit": 50,
90 "keyboard-shortcut": [
91 "f",
92 "/",
93 "s"
94 ],
95 "show-item-context": false,
96 "language": {
97 "search-no-results-text": "No results",
98 "search-matching-documents-text": "matching documents",
99 "search-copy-link-title": "Copy link to search",
100 "search-hide-matches-text": "Hide additional matches",
101 "search-more-match-text": "more match in this document",
102 "search-more-matches-text": "more matches in this document",
103 "search-clear-button-title": "Clear",
104 "search-text-placeholder": "",
105 "search-detached-cancel-button-title": "Cancel",
106 "search-submit-button-title": "Submit",
107 "search-label": "Search"
108 }
109}</script>
110
111
112<link rel="stylesheet" href="../assets/styles.css">
113</head>
114
115<body class="nav-sidebar docked nav-fixed quarto-light"><script id="quarto-html-before-body" type="application/javascript">
116 const toggleBodyColorMode = (bsSheetEl) => {
117 const mode = bsSheetEl.getAttribute("data-mode");
118 const bodyEl = window.document.querySelector("body");
119 if (mode === "dark") {
120 bodyEl.classList.add("quarto-dark");
121 bodyEl.classList.remove("quarto-light");
122 } else {
123 bodyEl.classList.add("quarto-light");
124 bodyEl.classList.remove("quarto-dark");
125 }
126 }
127 const toggleBodyColorPrimary = () => {
128 const bsSheetEl = window.document.querySelector("link#quarto-bootstrap:not([rel=disabled-stylesheet])");
129 if (bsSheetEl) {
130 toggleBodyColorMode(bsSheetEl);
131 }
132 }
133 const setColorSchemeToggle = (alternate) => {
134 const toggles = window.document.querySelectorAll('.quarto-color-scheme-toggle');
135 for (let i=0; i < toggles.length; i++) {
136 const toggle = toggles[i];
137 if (toggle) {
138 if (alternate) {
139 toggle.classList.add("alternate");
140 } else {
141 toggle.classList.remove("alternate");
142 }
143 }
144 }
145 };
146 const toggleColorMode = (alternate) => {
147 // Switch the stylesheets
148 const primaryStylesheets = window.document.querySelectorAll('link.quarto-color-scheme:not(.quarto-color-alternate)');
149 const alternateStylesheets = window.document.querySelectorAll('link.quarto-color-scheme.quarto-color-alternate');
150 manageTransitions('#quarto-margin-sidebar .nav-link', false);
151 if (alternate) {
152 // note: dark is layered on light, we don't disable primary!
153 enableStylesheet(alternateStylesheets);
154 for (const sheetNode of alternateStylesheets) {
155 if (sheetNode.id === "quarto-bootstrap") {
156 toggleBodyColorMode(sheetNode);
157 }
158 }
159 } else {
160 disableStylesheet(alternateStylesheets);
161 enableStylesheet(primaryStylesheets)
162 toggleBodyColorPrimary();
163 }
164 manageTransitions('#quarto-margin-sidebar .nav-link', true);
165 // Switch the toggles
166 setColorSchemeToggle(alternate)
167 // Hack to workaround the fact that safari doesn't
168 // properly recolor the scrollbar when toggling (#1455)
169 if (navigator.userAgent.indexOf('Safari') > 0 && navigator.userAgent.indexOf('Chrome') == -1) {
170 manageTransitions("body", false);
171 window.scrollTo(0, 1);
172 setTimeout(() => {
173 window.scrollTo(0, 0);
174 manageTransitions("body", true);
175 }, 40);
176 }
177 }
178 const disableStylesheet = (stylesheets) => {
179 for (let i=0; i < stylesheets.length; i++) {
180 const stylesheet = stylesheets[i];
181 stylesheet.rel = 'disabled-stylesheet';
182 }
183 }
184 const enableStylesheet = (stylesheets) => {
185 for (let i=0; i < stylesheets.length; i++) {
186 const stylesheet = stylesheets[i];
187 if(stylesheet.rel !== 'stylesheet') { // for Chrome, which will still FOUC without this check
188 stylesheet.rel = 'stylesheet';
189 }
190 }
191 }
192 const manageTransitions = (selector, allowTransitions) => {
193 const els = window.document.querySelectorAll(selector);
194 for (let i=0; i < els.length; i++) {
195 const el = els[i];
196 if (allowTransitions) {
197 el.classList.remove('notransition');
198 } else {
199 el.classList.add('notransition');
200 }
201 }
202 }
203 const isFileUrl = () => {
204 return window.location.protocol === 'file:';
205 }
206 const hasAlternateSentinel = () => {
207 let styleSentinel = getColorSchemeSentinel();
208 if (styleSentinel !== null) {
209 return styleSentinel === "alternate";
210 } else {
211 return false;
212 }
213 }
214 const setStyleSentinel = (alternate) => {
215 const value = alternate ? "alternate" : "default";
216 if (!isFileUrl()) {
217 window.localStorage.setItem("quarto-color-scheme", value);
218 } else {
219 localAlternateSentinel = value;
220 }
221 }
222 const getColorSchemeSentinel = () => {
223 if (!isFileUrl()) {
224 const storageValue = window.localStorage.getItem("quarto-color-scheme");
225 return storageValue != null ? storageValue : localAlternateSentinel;
226 } else {
227 return localAlternateSentinel;
228 }
229 }
230 const toggleGiscusIfUsed = (isAlternate, darkModeDefault) => {
231 const baseTheme = document.querySelector('#giscus-base-theme')?.value ?? 'light';
232 const alternateTheme = document.querySelector('#giscus-alt-theme')?.value ?? 'dark';
233 let newTheme = '';
234 if(authorPrefersDark) {
235 newTheme = isAlternate ? baseTheme : alternateTheme;
236 } else {
237 newTheme = isAlternate ? alternateTheme : baseTheme;
238 }
239 const changeGiscusTheme = () => {
240 // From: https://github.com/giscus/giscus/issues/336
241 const sendMessage = (message) => {
242 const iframe = document.querySelector('iframe.giscus-frame');
243 if (!iframe) return;
244 iframe.contentWindow.postMessage({ giscus: message }, 'https://giscus.app');
245 }
246 sendMessage({
247 setConfig: {
248 theme: newTheme
249 }
250 });
251 }
252 const isGiscussLoaded = window.document.querySelector('iframe.giscus-frame') !== null;
253 if (isGiscussLoaded) {
254 changeGiscusTheme();
255 }
256 };
257 const authorPrefersDark = false;
258 const darkModeDefault = authorPrefersDark;
259 document.querySelector('link#quarto-text-highlighting-styles.quarto-color-scheme-extra').rel = 'disabled-stylesheet';
260 document.querySelector('link#quarto-bootstrap.quarto-color-scheme-extra').rel = 'disabled-stylesheet';
261 let localAlternateSentinel = darkModeDefault ? 'alternate' : 'default';
262 // Dark / light mode switch
263 window.quartoToggleColorScheme = () => {
264 // Read the current dark / light value
265 let toAlternate = !hasAlternateSentinel();
266 toggleColorMode(toAlternate);
267 setStyleSentinel(toAlternate);
268 toggleGiscusIfUsed(toAlternate, darkModeDefault);
269 window.dispatchEvent(new Event('resize'));
270 };
271 // Switch to dark mode if need be
272 if (hasAlternateSentinel()) {
273 toggleColorMode(true);
274 } else {
275 toggleColorMode(false);
276 }
277 </script>
278
279<div id="quarto-search-results"></div>
280 <header id="quarto-header" class="headroom fixed-top">
281 <nav class="navbar navbar-expand-lg " data-bs-theme="dark">
282 <div class="navbar-container container-fluid">
283 <div class="navbar-brand-container mx-auto">
284 <a class="navbar-brand" href="../index.html">
285 <span class="navbar-title">atdata</span>
286 </a>
287 </div>
288 <div id="quarto-search" class="" title="Search"></div>
289 <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarCollapse" aria-controls="navbarCollapse" role="menu" aria-expanded="false" aria-label="Toggle navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
290 <span class="navbar-toggler-icon"></span>
291</button>
292 <div class="collapse navbar-collapse" id="navbarCollapse">
293 <ul class="navbar-nav navbar-nav-scroll me-auto">
294 <li class="nav-item">
295 <a class="nav-link active" href="../index.html" aria-current="page">
296<span class="menu-text">Guide</span></a>
297 </li>
298 <li class="nav-item dropdown ">
299 <a class="nav-link dropdown-toggle" href="#" id="nav-menu-tutorials" role="link" data-bs-toggle="dropdown" aria-expanded="false">
300 <span class="menu-text">Tutorials</span>
301 </a>
302 <ul class="dropdown-menu" aria-labelledby="nav-menu-tutorials">
303 <li>
304 <a class="dropdown-item" href="../tutorials/quickstart.html">
305 <span class="dropdown-text">Quick Start</span></a>
306 </li>
307 <li>
308 <a class="dropdown-item" href="../tutorials/local-workflow.html">
309 <span class="dropdown-text">Local Workflow</span></a>
310 </li>
311 <li>
312 <a class="dropdown-item" href="../tutorials/atmosphere.html">
313 <span class="dropdown-text">Atmosphere Publishing</span></a>
314 </li>
315 <li>
316 <a class="dropdown-item" href="../tutorials/promotion.html">
317 <span class="dropdown-text">Promotion Workflow</span></a>
318 </li>
319 </ul>
320 </li>
321 <li class="nav-item dropdown ">
322 <a class="nav-link dropdown-toggle" href="#" id="nav-menu-reference" role="link" data-bs-toggle="dropdown" aria-expanded="false">
323 <span class="menu-text">Reference</span>
324 </a>
325 <ul class="dropdown-menu" aria-labelledby="nav-menu-reference">
326 <li>
327 <a class="dropdown-item" href="../reference/architecture.html">
328 <span class="dropdown-text">Architecture Overview</span></a>
329 </li>
330 <li>
331 <a class="dropdown-item" href="../reference/packable-samples.html">
332 <span class="dropdown-text">Packable Samples</span></a>
333 </li>
334 <li>
335 <a class="dropdown-item" href="../reference/datasets.html">
336 <span class="dropdown-text">Datasets</span></a>
337 </li>
338 <li>
339 <a class="dropdown-item" href="../reference/lenses.html">
340 <span class="dropdown-text">Lenses</span></a>
341 </li>
342 <li>
343 <a class="dropdown-item" href="../reference/local-storage.html">
344 <span class="dropdown-text">Local Storage</span></a>
345 </li>
346 <li>
347 <a class="dropdown-item" href="../reference/atmosphere.html">
348 <span class="dropdown-text">Atmosphere</span></a>
349 </li>
350 <li>
351 <a class="dropdown-item" href="../reference/promotion.html">
352 <span class="dropdown-text">Promotion</span></a>
353 </li>
354 <li>
355 <a class="dropdown-item" href="../reference/load-dataset.html">
356 <span class="dropdown-text">load_dataset API</span></a>
357 </li>
358 <li>
359 <a class="dropdown-item" href="../reference/protocols.html">
360 <span class="dropdown-text">Protocols</span></a>
361 </li>
362 <li>
363 <a class="dropdown-item" href="../reference/uri-spec.html">
364 <span class="dropdown-text">URI Specification</span></a>
365 </li>
366 <li>
367 <a class="dropdown-item" href="../reference/troubleshooting.html">
368 <span class="dropdown-text">Troubleshooting & FAQ</span></a>
369 </li>
370 <li>
371 <a class="dropdown-item" href="../reference/deployment.html">
372 <span class="dropdown-text">Deployment Guide</span></a>
373 </li>
374 </ul>
375 </li>
376 <li class="nav-item">
377 <a class="nav-link" href="../api/index.html">
378<span class="menu-text">API</span></a>
379 </li>
380</ul>
381 <ul class="navbar-nav navbar-nav-scroll ms-auto">
382 <li class="nav-item compact">
383 <a class="nav-link" href="https://github.com/your-org/atdata"> <i class="bi bi-github" role="img">
384</i>
385<span class="menu-text"></span></a>
386 </li>
387</ul>
388 </div> <!-- /navcollapse -->
389 <div class="quarto-navbar-tools">
390 <a href="" class="quarto-color-scheme-toggle quarto-navigation-tool px-1" onclick="window.quartoToggleColorScheme(); return false;" title="Toggle dark mode"><i class="bi"></i></a>
391</div>
392 </div> <!-- /container-fluid -->
393 </nav>
394 <nav class="quarto-secondary-nav">
395 <div class="container-fluid d-flex">
396 <button type="button" class="quarto-btn-toggle btn" data-bs-toggle="collapse" role="button" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
397 <i class="bi bi-layout-text-sidebar-reverse"></i>
398 </button>
399 <nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="../tutorials/quickstart.html">Getting Started</a></li><li class="breadcrumb-item"><a href="../tutorials/promotion.html">Promotion Workflow</a></li></ol></nav>
400 <a class="flex-grow-1" role="navigation" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
401 </a>
402 </div>
403 </nav>
404</header>
405<!-- content -->
406<div id="quarto-content" class="quarto-container page-columns page-rows-contents page-layout-article page-navbar">
407<!-- sidebar -->
408 <nav id="quarto-sidebar" class="sidebar collapse collapse-horizontal quarto-sidebar-collapse-item sidebar-navigation docked overflow-auto">
409 <div class="sidebar-menu-container">
410 <ul class="list-unstyled mt-1">
411 <li class="sidebar-item">
412 <div class="sidebar-item-container">
413 <a href="../index.html" class="sidebar-item-text sidebar-link">
414 <span class="menu-text">atdata</span></a>
415 </div>
416</li>
417 <li class="sidebar-item sidebar-item-section">
418 <div class="sidebar-item-container">
419 <a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" role="navigation" aria-expanded="true">
420 <span class="menu-text">Getting Started</span></a>
421 <a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" role="navigation" aria-expanded="true" aria-label="Toggle section">
422 <i class="bi bi-chevron-right ms-2"></i>
423 </a>
424 </div>
425 <ul id="quarto-sidebar-section-1" class="collapse list-unstyled sidebar-section depth1 show">
426 <li class="sidebar-item">
427 <div class="sidebar-item-container">
428 <a href="../tutorials/quickstart.html" class="sidebar-item-text sidebar-link">
429 <span class="menu-text">Quick Start</span></a>
430 </div>
431</li>
432 <li class="sidebar-item">
433 <div class="sidebar-item-container">
434 <a href="../tutorials/local-workflow.html" class="sidebar-item-text sidebar-link">
435 <span class="menu-text">Local Workflow</span></a>
436 </div>
437</li>
438 <li class="sidebar-item">
439 <div class="sidebar-item-container">
440 <a href="../tutorials/atmosphere.html" class="sidebar-item-text sidebar-link">
441 <span class="menu-text">Atmosphere Publishing</span></a>
442 </div>
443</li>
444 <li class="sidebar-item">
445 <div class="sidebar-item-container">
446 <a href="../tutorials/promotion.html" class="sidebar-item-text sidebar-link active">
447 <span class="menu-text">Promotion Workflow</span></a>
448 </div>
449</li>
450 </ul>
451 </li>
452 <li class="sidebar-item sidebar-item-section">
453 <div class="sidebar-item-container">
454 <a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" role="navigation" aria-expanded="true">
455 <span class="menu-text">Reference</span></a>
456 <a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" role="navigation" aria-expanded="true" aria-label="Toggle section">
457 <i class="bi bi-chevron-right ms-2"></i>
458 </a>
459 </div>
460 <ul id="quarto-sidebar-section-2" class="collapse list-unstyled sidebar-section depth1 show">
461 <li class="sidebar-item">
462 <div class="sidebar-item-container">
463 <a href="../reference/architecture.html" class="sidebar-item-text sidebar-link">
464 <span class="menu-text">Architecture Overview</span></a>
465 </div>
466</li>
467 <li class="sidebar-item">
468 <div class="sidebar-item-container">
469 <a href="../reference/packable-samples.html" class="sidebar-item-text sidebar-link">
470 <span class="menu-text">Packable Samples</span></a>
471 </div>
472</li>
473 <li class="sidebar-item">
474 <div class="sidebar-item-container">
475 <a href="../reference/datasets.html" class="sidebar-item-text sidebar-link">
476 <span class="menu-text">Datasets</span></a>
477 </div>
478</li>
479 <li class="sidebar-item">
480 <div class="sidebar-item-container">
481 <a href="../reference/lenses.html" class="sidebar-item-text sidebar-link">
482 <span class="menu-text">Lenses</span></a>
483 </div>
484</li>
485 <li class="sidebar-item">
486 <div class="sidebar-item-container">
487 <a href="../reference/local-storage.html" class="sidebar-item-text sidebar-link">
488 <span class="menu-text">Local Storage</span></a>
489 </div>
490</li>
491 <li class="sidebar-item">
492 <div class="sidebar-item-container">
493 <a href="../reference/atmosphere.html" class="sidebar-item-text sidebar-link">
494 <span class="menu-text">Atmosphere (ATProto Integration)</span></a>
495 </div>
496</li>
497 <li class="sidebar-item">
498 <div class="sidebar-item-container">
499 <a href="../reference/promotion.html" class="sidebar-item-text sidebar-link">
500 <span class="menu-text">Promotion Workflow</span></a>
501 </div>
502</li>
503 <li class="sidebar-item">
504 <div class="sidebar-item-container">
505 <a href="../reference/load-dataset.html" class="sidebar-item-text sidebar-link">
506 <span class="menu-text">load_dataset API</span></a>
507 </div>
508</li>
509 <li class="sidebar-item">
510 <div class="sidebar-item-container">
511 <a href="../reference/protocols.html" class="sidebar-item-text sidebar-link">
512 <span class="menu-text">Protocols</span></a>
513 </div>
514</li>
515 <li class="sidebar-item">
516 <div class="sidebar-item-container">
517 <a href="../reference/uri-spec.html" class="sidebar-item-text sidebar-link">
518 <span class="menu-text">URI Specification</span></a>
519 </div>
520</li>
521 <li class="sidebar-item">
522 <div class="sidebar-item-container">
523 <a href="../reference/troubleshooting.html" class="sidebar-item-text sidebar-link">
524 <span class="menu-text">Troubleshooting & FAQ</span></a>
525 </div>
526</li>
527 <li class="sidebar-item">
528 <div class="sidebar-item-container">
529 <a href="../reference/deployment.html" class="sidebar-item-text sidebar-link">
530 <span class="menu-text">Deployment Guide</span></a>
531 </div>
532</li>
533 </ul>
534 </li>
535 </ul>
536 </div>
537</nav>
538<div id="quarto-sidebar-glass" class="quarto-sidebar-collapse-item" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item"></div>
539<!-- margin-sidebar -->
540 <div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
541 <nav id="TOC" role="doc-toc" class="toc-active">
542 <h2 id="toc-title">On this page</h2>
543
544 <ul>
545 <li><a href="#why-promotion" id="toc-why-promotion" class="nav-link active" data-scroll-target="#why-promotion">Why Promotion?</a></li>
546 <li><a href="#overview" id="toc-overview" class="nav-link" data-scroll-target="#overview">Overview</a></li>
547 <li><a href="#setup" id="toc-setup" class="nav-link" data-scroll-target="#setup">Setup</a></li>
548 <li><a href="#prepare-a-local-dataset" id="toc-prepare-a-local-dataset" class="nav-link" data-scroll-target="#prepare-a-local-dataset">Prepare a Local Dataset</a></li>
549 <li><a href="#basic-promotion" id="toc-basic-promotion" class="nav-link" data-scroll-target="#basic-promotion">Basic Promotion</a></li>
550 <li><a href="#promotion-with-metadata" id="toc-promotion-with-metadata" class="nav-link" data-scroll-target="#promotion-with-metadata">Promotion with Metadata</a></li>
551 <li><a href="#schema-deduplication" id="toc-schema-deduplication" class="nav-link" data-scroll-target="#schema-deduplication">Schema Deduplication</a></li>
552 <li><a href="#data-migration-options" id="toc-data-migration-options" class="nav-link" data-scroll-target="#data-migration-options">Data Migration Options</a></li>
553 <li><a href="#verify-on-atmosphere" id="toc-verify-on-atmosphere" class="nav-link" data-scroll-target="#verify-on-atmosphere">Verify on Atmosphere</a></li>
554 <li><a href="#error-handling" id="toc-error-handling" class="nav-link" data-scroll-target="#error-handling">Error Handling</a></li>
555 <li><a href="#requirements-checklist" id="toc-requirements-checklist" class="nav-link" data-scroll-target="#requirements-checklist">Requirements Checklist</a></li>
556 <li><a href="#complete-workflow" id="toc-complete-workflow" class="nav-link" data-scroll-target="#complete-workflow">Complete Workflow</a></li>
557 <li><a href="#what-youve-learned" id="toc-what-youve-learned" class="nav-link" data-scroll-target="#what-youve-learned">What You’ve Learned</a></li>
558 <li><a href="#the-complete-journey" id="toc-the-complete-journey" class="nav-link" data-scroll-target="#the-complete-journey">The Complete Journey</a></li>
559 <li><a href="#next-steps" id="toc-next-steps" class="nav-link" data-scroll-target="#next-steps">Next Steps</a></li>
560 </ul>
561<div class="toc-actions"><ul><li><a href="https://github.com/your-org/atdata/edit/main/tutorials/promotion.qmd" class="toc-action"><i class="bi bi-github"></i>Edit this page</a></li><li><a href="https://github.com/your-org/atdata/issues/new" class="toc-action"><i class="bi empty"></i>Report an issue</a></li></ul></div></nav>
562 </div>
563<!-- main -->
564<main class="content" id="quarto-document-content">
565
566
567<header id="title-block-header" class="quarto-title-block default"><nav class="quarto-page-breadcrumbs quarto-title-breadcrumbs d-none d-lg-block" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="../tutorials/quickstart.html">Getting Started</a></li><li class="breadcrumb-item"><a href="../tutorials/promotion.html">Promotion Workflow</a></li></ol></nav>
568<div class="quarto-title">
569<h1 class="title">Promotion Workflow</h1>
570</div>
571
572<div>
573 <div class="description">
574 Migrate datasets from local storage to ATProto
575 </div>
576</div>
577
578
579<div class="quarto-title-meta">
580
581
582
583
584 </div>
585
586
587
588</header>
589
590
591<p>This tutorial demonstrates the workflow for migrating datasets from local Redis/S3 storage to the federated ATProto atmosphere network. Promotion is the bridge between <strong>Layer 2</strong> (team storage) and <strong>Layer 3</strong> (federation).</p>
592<section id="why-promotion" class="level2">
593<h2 class="anchored" data-anchor-id="why-promotion">Why Promotion?</h2>
594<p>A common pattern in data science:</p>
595<ol type="1">
596<li><strong>Start private</strong>: Develop and validate datasets within your team</li>
597<li><strong>Go public</strong>: Share successful datasets with the broader community</li>
598</ol>
599<p>Promotion handles this transition without re-processing your data. Instead of creating a new dataset from scratch, you’re <strong>lifting</strong> an existing local dataset entry into the federated atmosphere.</p>
600<p>The workflow handles several complexities automatically:</p>
601<ul>
602<li><strong>Schema deduplication</strong>: If you’ve already published the same schema type and version, promotion reuses it</li>
603<li><strong>URL preservation</strong>: Data stays in place (unless you explicitly want to copy it)</li>
604<li><strong>CID consistency</strong>: Content identifiers remain valid across the transition</li>
605</ul>
606</section>
607<section id="overview" class="level2">
608<h2 class="anchored" data-anchor-id="overview">Overview</h2>
609<p>The promotion workflow moves datasets from local storage to the atmosphere:</p>
610<pre><code>LOCAL ATMOSPHERE
611----- ----------
612Redis Index ATProto PDS
613S3 Storage --> (same S3 or new location)
614local://schemas/... at://did:plc:.../schema/...</code></pre>
615<p>Key features:</p>
616<ul>
617<li><strong>Schema deduplication</strong>: Won’t republish identical schemas</li>
618<li><strong>Flexible data handling</strong>: Keep existing URLs or copy to new storage</li>
619<li><strong>Metadata preservation</strong>: Local metadata carries over to atmosphere</li>
620</ul>
621</section>
622<section id="setup" class="level2">
623<h2 class="anchored" data-anchor-id="setup">Setup</h2>
624<div id="e3fb0424" class="cell">
625<div class="sourceCode cell-code" id="cb2"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="im">import</span> numpy <span class="im">as</span> np</span>
626<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> numpy.typing <span class="im">import</span> NDArray</span>
627<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a><span class="im">import</span> atdata</span>
628<span id="cb2-4"><a href="#cb2-4" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> atdata.local <span class="im">import</span> LocalIndex, LocalDatasetEntry, S3DataStore</span>
629<span id="cb2-5"><a href="#cb2-5" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> atdata.atmosphere <span class="im">import</span> AtmosphereClient</span>
630<span id="cb2-6"><a href="#cb2-6" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> atdata.promote <span class="im">import</span> promote_to_atmosphere</span>
631<span id="cb2-7"><a href="#cb2-7" aria-hidden="true" tabindex="-1"></a><span class="im">import</span> webdataset <span class="im">as</span> wds</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
632</div>
633</section>
634<section id="prepare-a-local-dataset" class="level2">
635<h2 class="anchored" data-anchor-id="prepare-a-local-dataset">Prepare a Local Dataset</h2>
636<p>First, set up a dataset in local storage:</p>
637<div id="b9d50874" class="cell">
638<div class="sourceCode cell-code" id="cb3"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="co"># 1. Define sample type</span></span>
639<span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a><span class="at">@atdata.packable</span></span>
640<span id="cb3-3"><a href="#cb3-3" aria-hidden="true" tabindex="-1"></a><span class="kw">class</span> ExperimentSample:</span>
641<span id="cb3-4"><a href="#cb3-4" aria-hidden="true" tabindex="-1"></a> <span class="co">"""A sample from a scientific experiment."""</span></span>
642<span id="cb3-5"><a href="#cb3-5" aria-hidden="true" tabindex="-1"></a> measurement: NDArray</span>
643<span id="cb3-6"><a href="#cb3-6" aria-hidden="true" tabindex="-1"></a> timestamp: <span class="bu">float</span></span>
644<span id="cb3-7"><a href="#cb3-7" aria-hidden="true" tabindex="-1"></a> sensor_id: <span class="bu">str</span></span>
645<span id="cb3-8"><a href="#cb3-8" aria-hidden="true" tabindex="-1"></a></span>
646<span id="cb3-9"><a href="#cb3-9" aria-hidden="true" tabindex="-1"></a><span class="co"># 2. Create samples</span></span>
647<span id="cb3-10"><a href="#cb3-10" aria-hidden="true" tabindex="-1"></a>samples <span class="op">=</span> [</span>
648<span id="cb3-11"><a href="#cb3-11" aria-hidden="true" tabindex="-1"></a> ExperimentSample(</span>
649<span id="cb3-12"><a href="#cb3-12" aria-hidden="true" tabindex="-1"></a> measurement<span class="op">=</span>np.random.randn(<span class="dv">64</span>).astype(np.float32),</span>
650<span id="cb3-13"><a href="#cb3-13" aria-hidden="true" tabindex="-1"></a> timestamp<span class="op">=</span><span class="bu">float</span>(i),</span>
651<span id="cb3-14"><a href="#cb3-14" aria-hidden="true" tabindex="-1"></a> sensor_id<span class="op">=</span><span class="ss">f"sensor_</span><span class="sc">{</span>i <span class="op">%</span> <span class="dv">4</span><span class="sc">}</span><span class="ss">"</span>,</span>
652<span id="cb3-15"><a href="#cb3-15" aria-hidden="true" tabindex="-1"></a> )</span>
653<span id="cb3-16"><a href="#cb3-16" aria-hidden="true" tabindex="-1"></a> <span class="cf">for</span> i <span class="kw">in</span> <span class="bu">range</span>(<span class="dv">1000</span>)</span>
654<span id="cb3-17"><a href="#cb3-17" aria-hidden="true" tabindex="-1"></a>]</span>
655<span id="cb3-18"><a href="#cb3-18" aria-hidden="true" tabindex="-1"></a></span>
656<span id="cb3-19"><a href="#cb3-19" aria-hidden="true" tabindex="-1"></a><span class="co"># 3. Write to tar</span></span>
657<span id="cb3-20"><a href="#cb3-20" aria-hidden="true" tabindex="-1"></a><span class="cf">with</span> wds.writer.TarWriter(<span class="st">"experiment.tar"</span>) <span class="im">as</span> sink:</span>
658<span id="cb3-21"><a href="#cb3-21" aria-hidden="true" tabindex="-1"></a> <span class="cf">for</span> i, s <span class="kw">in</span> <span class="bu">enumerate</span>(samples):</span>
659<span id="cb3-22"><a href="#cb3-22" aria-hidden="true" tabindex="-1"></a> sink.write({<span class="op">**</span>s.as_wds, <span class="st">"__key__"</span>: <span class="ss">f"</span><span class="sc">{</span>i<span class="sc">:06d}</span><span class="ss">"</span>})</span>
660<span id="cb3-23"><a href="#cb3-23" aria-hidden="true" tabindex="-1"></a></span>
661<span id="cb3-24"><a href="#cb3-24" aria-hidden="true" tabindex="-1"></a><span class="co"># 4. Set up local index with S3 storage</span></span>
662<span id="cb3-25"><a href="#cb3-25" aria-hidden="true" tabindex="-1"></a>store <span class="op">=</span> S3DataStore(</span>
663<span id="cb3-26"><a href="#cb3-26" aria-hidden="true" tabindex="-1"></a> credentials<span class="op">=</span>{</span>
664<span id="cb3-27"><a href="#cb3-27" aria-hidden="true" tabindex="-1"></a> <span class="st">"AWS_ENDPOINT"</span>: <span class="st">"http://localhost:9000"</span>,</span>
665<span id="cb3-28"><a href="#cb3-28" aria-hidden="true" tabindex="-1"></a> <span class="st">"AWS_ACCESS_KEY_ID"</span>: <span class="st">"minioadmin"</span>,</span>
666<span id="cb3-29"><a href="#cb3-29" aria-hidden="true" tabindex="-1"></a> <span class="st">"AWS_SECRET_ACCESS_KEY"</span>: <span class="st">"minioadmin"</span>,</span>
667<span id="cb3-30"><a href="#cb3-30" aria-hidden="true" tabindex="-1"></a> },</span>
668<span id="cb3-31"><a href="#cb3-31" aria-hidden="true" tabindex="-1"></a> bucket<span class="op">=</span><span class="st">"datasets-bucket"</span>,</span>
669<span id="cb3-32"><a href="#cb3-32" aria-hidden="true" tabindex="-1"></a>)</span>
670<span id="cb3-33"><a href="#cb3-33" aria-hidden="true" tabindex="-1"></a>local_index <span class="op">=</span> LocalIndex(data_store<span class="op">=</span>store)</span>
671<span id="cb3-34"><a href="#cb3-34" aria-hidden="true" tabindex="-1"></a></span>
672<span id="cb3-35"><a href="#cb3-35" aria-hidden="true" tabindex="-1"></a><span class="co"># 5. Insert dataset into index</span></span>
673<span id="cb3-36"><a href="#cb3-36" aria-hidden="true" tabindex="-1"></a>dataset <span class="op">=</span> atdata.Dataset[ExperimentSample](<span class="st">"experiment.tar"</span>)</span>
674<span id="cb3-37"><a href="#cb3-37" aria-hidden="true" tabindex="-1"></a>local_entry <span class="op">=</span> local_index.insert_dataset(dataset, name<span class="op">=</span><span class="st">"experiment-2024-001"</span>, prefix<span class="op">=</span><span class="st">"experiments"</span>)</span>
675<span id="cb3-38"><a href="#cb3-38" aria-hidden="true" tabindex="-1"></a></span>
676<span id="cb3-39"><a href="#cb3-39" aria-hidden="true" tabindex="-1"></a><span class="co"># 6. Publish schema to local index</span></span>
677<span id="cb3-40"><a href="#cb3-40" aria-hidden="true" tabindex="-1"></a>local_index.publish_schema(ExperimentSample, version<span class="op">=</span><span class="st">"1.0.0"</span>)</span>
678<span id="cb3-41"><a href="#cb3-41" aria-hidden="true" tabindex="-1"></a></span>
679<span id="cb3-42"><a href="#cb3-42" aria-hidden="true" tabindex="-1"></a><span class="bu">print</span>(<span class="ss">f"Local entry name: </span><span class="sc">{</span>local_entry<span class="sc">.</span>name<span class="sc">}</span><span class="ss">"</span>)</span>
680<span id="cb3-43"><a href="#cb3-43" aria-hidden="true" tabindex="-1"></a><span class="bu">print</span>(<span class="ss">f"Local entry CID: </span><span class="sc">{</span>local_entry<span class="sc">.</span>cid<span class="sc">}</span><span class="ss">"</span>)</span>
681<span id="cb3-44"><a href="#cb3-44" aria-hidden="true" tabindex="-1"></a><span class="bu">print</span>(<span class="ss">f"Data URLs: </span><span class="sc">{</span>local_entry<span class="sc">.</span>data_urls<span class="sc">}</span><span class="ss">"</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
682</div>
683</section>
684<section id="basic-promotion" class="level2">
685<h2 class="anchored" data-anchor-id="basic-promotion">Basic Promotion</h2>
686<p>Promote the dataset to ATProto:</p>
687<div id="03d13bda" class="cell">
688<div class="sourceCode cell-code" id="cb4"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="co"># Connect to atmosphere</span></span>
689<span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a>client <span class="op">=</span> AtmosphereClient()</span>
690<span id="cb4-3"><a href="#cb4-3" aria-hidden="true" tabindex="-1"></a>client.login(<span class="st">"myhandle.bsky.social"</span>, <span class="st">"app-password"</span>)</span>
691<span id="cb4-4"><a href="#cb4-4" aria-hidden="true" tabindex="-1"></a></span>
692<span id="cb4-5"><a href="#cb4-5" aria-hidden="true" tabindex="-1"></a><span class="co"># Promote to atmosphere</span></span>
693<span id="cb4-6"><a href="#cb4-6" aria-hidden="true" tabindex="-1"></a>at_uri <span class="op">=</span> promote_to_atmosphere(local_entry, local_index, client)</span>
694<span id="cb4-7"><a href="#cb4-7" aria-hidden="true" tabindex="-1"></a><span class="bu">print</span>(<span class="ss">f"Published: </span><span class="sc">{</span>at_uri<span class="sc">}</span><span class="ss">"</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
695</div>
696</section>
697<section id="promotion-with-metadata" class="level2">
698<h2 class="anchored" data-anchor-id="promotion-with-metadata">Promotion with Metadata</h2>
699<p>Add description, tags, and license:</p>
700<div id="78f1fe71" class="cell">
701<div class="sourceCode cell-code" id="cb5"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a>at_uri <span class="op">=</span> promote_to_atmosphere(</span>
702<span id="cb5-2"><a href="#cb5-2" aria-hidden="true" tabindex="-1"></a> local_entry,</span>
703<span id="cb5-3"><a href="#cb5-3" aria-hidden="true" tabindex="-1"></a> local_index,</span>
704<span id="cb5-4"><a href="#cb5-4" aria-hidden="true" tabindex="-1"></a> client,</span>
705<span id="cb5-5"><a href="#cb5-5" aria-hidden="true" tabindex="-1"></a> name<span class="op">=</span><span class="st">"experiment-2024-001-v2"</span>, <span class="co"># Override name</span></span>
706<span id="cb5-6"><a href="#cb5-6" aria-hidden="true" tabindex="-1"></a> description<span class="op">=</span><span class="st">"Sensor measurements from Lab 302"</span>,</span>
707<span id="cb5-7"><a href="#cb5-7" aria-hidden="true" tabindex="-1"></a> tags<span class="op">=</span>[<span class="st">"experiment"</span>, <span class="st">"physics"</span>, <span class="st">"2024"</span>],</span>
708<span id="cb5-8"><a href="#cb5-8" aria-hidden="true" tabindex="-1"></a> license<span class="op">=</span><span class="st">"CC-BY-4.0"</span>,</span>
709<span id="cb5-9"><a href="#cb5-9" aria-hidden="true" tabindex="-1"></a>)</span>
710<span id="cb5-10"><a href="#cb5-10" aria-hidden="true" tabindex="-1"></a><span class="bu">print</span>(<span class="ss">f"Published with metadata: </span><span class="sc">{</span>at_uri<span class="sc">}</span><span class="ss">"</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
711</div>
712</section>
713<section id="schema-deduplication" class="level2">
714<h2 class="anchored" data-anchor-id="schema-deduplication">Schema Deduplication</h2>
715<p>The promotion workflow automatically checks for existing schemas:</p>
716<div id="89e88b54" class="cell">
717<div class="sourceCode cell-code" id="cb6"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> atdata.promote <span class="im">import</span> _find_existing_schema</span>
718<span id="cb6-2"><a href="#cb6-2" aria-hidden="true" tabindex="-1"></a></span>
719<span id="cb6-3"><a href="#cb6-3" aria-hidden="true" tabindex="-1"></a><span class="co"># Check if schema already exists</span></span>
720<span id="cb6-4"><a href="#cb6-4" aria-hidden="true" tabindex="-1"></a>existing <span class="op">=</span> _find_existing_schema(client, <span class="st">"ExperimentSample"</span>, <span class="st">"1.0.0"</span>)</span>
721<span id="cb6-5"><a href="#cb6-5" aria-hidden="true" tabindex="-1"></a><span class="cf">if</span> existing:</span>
722<span id="cb6-6"><a href="#cb6-6" aria-hidden="true" tabindex="-1"></a> <span class="bu">print</span>(<span class="ss">f"Found existing schema: </span><span class="sc">{</span>existing<span class="sc">}</span><span class="ss">"</span>)</span>
723<span id="cb6-7"><a href="#cb6-7" aria-hidden="true" tabindex="-1"></a> <span class="bu">print</span>(<span class="st">"Will reuse instead of republishing"</span>)</span>
724<span id="cb6-8"><a href="#cb6-8" aria-hidden="true" tabindex="-1"></a><span class="cf">else</span>:</span>
725<span id="cb6-9"><a href="#cb6-9" aria-hidden="true" tabindex="-1"></a> <span class="bu">print</span>(<span class="st">"No existing schema found, will publish new one"</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
726</div>
727<p>When you promote multiple datasets with the same sample type:</p>
728<div id="d5e0911d" class="cell">
729<div class="sourceCode cell-code" id="cb7"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb7-1"><a href="#cb7-1" aria-hidden="true" tabindex="-1"></a><span class="co"># First promotion: publishes schema</span></span>
730<span id="cb7-2"><a href="#cb7-2" aria-hidden="true" tabindex="-1"></a>uri1 <span class="op">=</span> promote_to_atmosphere(entry1, local_index, client)</span>
731<span id="cb7-3"><a href="#cb7-3" aria-hidden="true" tabindex="-1"></a></span>
732<span id="cb7-4"><a href="#cb7-4" aria-hidden="true" tabindex="-1"></a><span class="co"># Second promotion with same schema type + version: reuses existing schema</span></span>
733<span id="cb7-5"><a href="#cb7-5" aria-hidden="true" tabindex="-1"></a>uri2 <span class="op">=</span> promote_to_atmosphere(entry2, local_index, client)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
734</div>
735</section>
736<section id="data-migration-options" class="level2">
737<h2 class="anchored" data-anchor-id="data-migration-options">Data Migration Options</h2>
738<div class="tabset-margin-container"></div><div class="panel-tabset">
739<ul class="nav nav-tabs" role="tablist"><li class="nav-item" role="presentation"><a class="nav-link active" id="tabset-1-1-tab" data-bs-toggle="tab" data-bs-target="#tabset-1-1" role="tab" aria-controls="tabset-1-1" aria-selected="true">Keep Existing URLs</a></li><li class="nav-item" role="presentation"><a class="nav-link" id="tabset-1-2-tab" data-bs-toggle="tab" data-bs-target="#tabset-1-2" role="tab" aria-controls="tabset-1-2" aria-selected="false">Copy to New Storage</a></li></ul>
740<div class="tab-content">
741<div id="tabset-1-1" class="tab-pane active" role="tabpanel" aria-labelledby="tabset-1-1-tab">
742<p>By default, promotion keeps the original data URLs:</p>
743<div id="c050b783" class="cell">
744<div class="sourceCode cell-code" id="cb8"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb8-1"><a href="#cb8-1" aria-hidden="true" tabindex="-1"></a><span class="co"># Data stays in original S3 location</span></span>
745<span id="cb8-2"><a href="#cb8-2" aria-hidden="true" tabindex="-1"></a>at_uri <span class="op">=</span> promote_to_atmosphere(local_entry, local_index, client)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
746</div>
747<p>Benefits:</p>
748<ul>
749<li>Fastest option, no data copying</li>
750<li>Dataset record points to existing URLs</li>
751<li>Requires original storage to remain accessible</li>
752</ul>
753</div>
754<div id="tabset-1-2" class="tab-pane" role="tabpanel" aria-labelledby="tabset-1-2-tab">
755<p>To copy data to a different storage location:</p>
756<div id="6db17021" class="cell">
757<div class="sourceCode cell-code" id="cb9"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb9-1"><a href="#cb9-1" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> atdata.local <span class="im">import</span> S3DataStore</span>
758<span id="cb9-2"><a href="#cb9-2" aria-hidden="true" tabindex="-1"></a></span>
759<span id="cb9-3"><a href="#cb9-3" aria-hidden="true" tabindex="-1"></a><span class="co"># Create new data store</span></span>
760<span id="cb9-4"><a href="#cb9-4" aria-hidden="true" tabindex="-1"></a>new_store <span class="op">=</span> S3DataStore(</span>
761<span id="cb9-5"><a href="#cb9-5" aria-hidden="true" tabindex="-1"></a> credentials<span class="op">=</span><span class="st">"new-s3-creds.env"</span>,</span>
762<span id="cb9-6"><a href="#cb9-6" aria-hidden="true" tabindex="-1"></a> bucket<span class="op">=</span><span class="st">"public-datasets"</span>,</span>
763<span id="cb9-7"><a href="#cb9-7" aria-hidden="true" tabindex="-1"></a>)</span>
764<span id="cb9-8"><a href="#cb9-8" aria-hidden="true" tabindex="-1"></a></span>
765<span id="cb9-9"><a href="#cb9-9" aria-hidden="true" tabindex="-1"></a><span class="co"># Promote with data copy</span></span>
766<span id="cb9-10"><a href="#cb9-10" aria-hidden="true" tabindex="-1"></a>at_uri <span class="op">=</span> promote_to_atmosphere(</span>
767<span id="cb9-11"><a href="#cb9-11" aria-hidden="true" tabindex="-1"></a> local_entry,</span>
768<span id="cb9-12"><a href="#cb9-12" aria-hidden="true" tabindex="-1"></a> local_index,</span>
769<span id="cb9-13"><a href="#cb9-13" aria-hidden="true" tabindex="-1"></a> client,</span>
770<span id="cb9-14"><a href="#cb9-14" aria-hidden="true" tabindex="-1"></a> data_store<span class="op">=</span>new_store, <span class="co"># Copy data to new storage</span></span>
771<span id="cb9-15"><a href="#cb9-15" aria-hidden="true" tabindex="-1"></a>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
772</div>
773<p>Benefits:</p>
774<ul>
775<li>Data is copied to new bucket</li>
776<li>Good for moving from private to public storage</li>
777<li>Original storage can be retired</li>
778</ul>
779</div>
780</div>
781</div>
782</section>
783<section id="verify-on-atmosphere" class="level2">
784<h2 class="anchored" data-anchor-id="verify-on-atmosphere">Verify on Atmosphere</h2>
785<p>After promotion, verify the dataset is accessible:</p>
786<div id="46c36a34" class="cell">
787<div class="sourceCode cell-code" id="cb10"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb10-1"><a href="#cb10-1" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> atdata.atmosphere <span class="im">import</span> AtmosphereIndex</span>
788<span id="cb10-2"><a href="#cb10-2" aria-hidden="true" tabindex="-1"></a></span>
789<span id="cb10-3"><a href="#cb10-3" aria-hidden="true" tabindex="-1"></a>atm_index <span class="op">=</span> AtmosphereIndex(client)</span>
790<span id="cb10-4"><a href="#cb10-4" aria-hidden="true" tabindex="-1"></a>entry <span class="op">=</span> atm_index.get_dataset(at_uri)</span>
791<span id="cb10-5"><a href="#cb10-5" aria-hidden="true" tabindex="-1"></a></span>
792<span id="cb10-6"><a href="#cb10-6" aria-hidden="true" tabindex="-1"></a><span class="bu">print</span>(<span class="ss">f"Name: </span><span class="sc">{</span>entry<span class="sc">.</span>name<span class="sc">}</span><span class="ss">"</span>)</span>
793<span id="cb10-7"><a href="#cb10-7" aria-hidden="true" tabindex="-1"></a><span class="bu">print</span>(<span class="ss">f"Schema: </span><span class="sc">{</span>entry<span class="sc">.</span>schema_ref<span class="sc">}</span><span class="ss">"</span>)</span>
794<span id="cb10-8"><a href="#cb10-8" aria-hidden="true" tabindex="-1"></a><span class="bu">print</span>(<span class="ss">f"URLs: </span><span class="sc">{</span>entry<span class="sc">.</span>data_urls<span class="sc">}</span><span class="ss">"</span>)</span>
795<span id="cb10-9"><a href="#cb10-9" aria-hidden="true" tabindex="-1"></a></span>
796<span id="cb10-10"><a href="#cb10-10" aria-hidden="true" tabindex="-1"></a><span class="co"># Load and iterate</span></span>
797<span id="cb10-11"><a href="#cb10-11" aria-hidden="true" tabindex="-1"></a>SampleType <span class="op">=</span> atm_index.decode_schema(entry.schema_ref)</span>
798<span id="cb10-12"><a href="#cb10-12" aria-hidden="true" tabindex="-1"></a>ds <span class="op">=</span> atdata.Dataset[SampleType](entry.data_urls[<span class="dv">0</span>])</span>
799<span id="cb10-13"><a href="#cb10-13" aria-hidden="true" tabindex="-1"></a></span>
800<span id="cb10-14"><a href="#cb10-14" aria-hidden="true" tabindex="-1"></a><span class="cf">for</span> batch <span class="kw">in</span> ds.ordered(batch_size<span class="op">=</span><span class="dv">32</span>):</span>
801<span id="cb10-15"><a href="#cb10-15" aria-hidden="true" tabindex="-1"></a> <span class="bu">print</span>(<span class="ss">f"Measurement shape: </span><span class="sc">{</span>batch<span class="sc">.</span>measurement<span class="sc">.</span>shape<span class="sc">}</span><span class="ss">"</span>)</span>
802<span id="cb10-16"><a href="#cb10-16" aria-hidden="true" tabindex="-1"></a> <span class="cf">break</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
803</div>
804</section>
805<section id="error-handling" class="level2">
806<h2 class="anchored" data-anchor-id="error-handling">Error Handling</h2>
807<div id="ff95cdd2" class="cell">
808<div class="sourceCode cell-code" id="cb11"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb11-1"><a href="#cb11-1" aria-hidden="true" tabindex="-1"></a><span class="cf">try</span>:</span>
809<span id="cb11-2"><a href="#cb11-2" aria-hidden="true" tabindex="-1"></a> at_uri <span class="op">=</span> promote_to_atmosphere(local_entry, local_index, client)</span>
810<span id="cb11-3"><a href="#cb11-3" aria-hidden="true" tabindex="-1"></a><span class="cf">except</span> <span class="pp">KeyError</span> <span class="im">as</span> e:</span>
811<span id="cb11-4"><a href="#cb11-4" aria-hidden="true" tabindex="-1"></a> <span class="co"># Schema not found in local index</span></span>
812<span id="cb11-5"><a href="#cb11-5" aria-hidden="true" tabindex="-1"></a> <span class="bu">print</span>(<span class="ss">f"Missing schema: </span><span class="sc">{</span>e<span class="sc">}</span><span class="ss">"</span>)</span>
813<span id="cb11-6"><a href="#cb11-6" aria-hidden="true" tabindex="-1"></a> <span class="bu">print</span>(<span class="st">"Publish schema first: local_index.publish_schema(SampleType)"</span>)</span>
814<span id="cb11-7"><a href="#cb11-7" aria-hidden="true" tabindex="-1"></a><span class="cf">except</span> <span class="pp">ValueError</span> <span class="im">as</span> e:</span>
815<span id="cb11-8"><a href="#cb11-8" aria-hidden="true" tabindex="-1"></a> <span class="co"># Entry has no data URLs</span></span>
816<span id="cb11-9"><a href="#cb11-9" aria-hidden="true" tabindex="-1"></a> <span class="bu">print</span>(<span class="ss">f"Invalid entry: </span><span class="sc">{</span>e<span class="sc">}</span><span class="ss">"</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
817</div>
818</section>
819<section id="requirements-checklist" class="level2">
820<h2 class="anchored" data-anchor-id="requirements-checklist">Requirements Checklist</h2>
821<p>Before promotion:</p>
822<ul class="task-list">
823<li><label><input type="checkbox">Dataset is in local index (via <code>LocalIndex.insert_dataset()</code> or <code>LocalIndex.add_entry()</code>)</label></li>
824<li><label><input type="checkbox">Schema is published to local index (via <code>LocalIndex.publish_schema()</code>)</label></li>
825<li><label><input type="checkbox">AtmosphereClient is authenticated</label></li>
826<li><label><input type="checkbox">Data URLs are publicly accessible (or will be copied)</label></li>
827</ul>
828</section>
829<section id="complete-workflow" class="level2">
830<h2 class="anchored" data-anchor-id="complete-workflow">Complete Workflow</h2>
831<div id="54c7fb18" class="cell">
832<div class="sourceCode cell-code" id="cb12"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb12-1"><a href="#cb12-1" aria-hidden="true" tabindex="-1"></a><span class="co"># Complete local-to-atmosphere workflow</span></span>
833<span id="cb12-2"><a href="#cb12-2" aria-hidden="true" tabindex="-1"></a><span class="im">import</span> numpy <span class="im">as</span> np</span>
834<span id="cb12-3"><a href="#cb12-3" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> numpy.typing <span class="im">import</span> NDArray</span>
835<span id="cb12-4"><a href="#cb12-4" aria-hidden="true" tabindex="-1"></a><span class="im">import</span> atdata</span>
836<span id="cb12-5"><a href="#cb12-5" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> atdata.local <span class="im">import</span> LocalIndex, S3DataStore</span>
837<span id="cb12-6"><a href="#cb12-6" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> atdata.atmosphere <span class="im">import</span> AtmosphereClient, AtmosphereIndex</span>
838<span id="cb12-7"><a href="#cb12-7" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> atdata.promote <span class="im">import</span> promote_to_atmosphere</span>
839<span id="cb12-8"><a href="#cb12-8" aria-hidden="true" tabindex="-1"></a><span class="im">import</span> webdataset <span class="im">as</span> wds</span>
840<span id="cb12-9"><a href="#cb12-9" aria-hidden="true" tabindex="-1"></a></span>
841<span id="cb12-10"><a href="#cb12-10" aria-hidden="true" tabindex="-1"></a><span class="co"># 1. Define sample type</span></span>
842<span id="cb12-11"><a href="#cb12-11" aria-hidden="true" tabindex="-1"></a><span class="at">@atdata.packable</span></span>
843<span id="cb12-12"><a href="#cb12-12" aria-hidden="true" tabindex="-1"></a><span class="kw">class</span> FeatureSample:</span>
844<span id="cb12-13"><a href="#cb12-13" aria-hidden="true" tabindex="-1"></a> features: NDArray</span>
845<span id="cb12-14"><a href="#cb12-14" aria-hidden="true" tabindex="-1"></a> label: <span class="bu">int</span></span>
846<span id="cb12-15"><a href="#cb12-15" aria-hidden="true" tabindex="-1"></a></span>
847<span id="cb12-16"><a href="#cb12-16" aria-hidden="true" tabindex="-1"></a><span class="co"># 2. Create dataset tar</span></span>
848<span id="cb12-17"><a href="#cb12-17" aria-hidden="true" tabindex="-1"></a>samples <span class="op">=</span> [</span>
849<span id="cb12-18"><a href="#cb12-18" aria-hidden="true" tabindex="-1"></a> FeatureSample(</span>
850<span id="cb12-19"><a href="#cb12-19" aria-hidden="true" tabindex="-1"></a> features<span class="op">=</span>np.random.randn(<span class="dv">128</span>).astype(np.float32),</span>
851<span id="cb12-20"><a href="#cb12-20" aria-hidden="true" tabindex="-1"></a> label<span class="op">=</span>i <span class="op">%</span> <span class="dv">10</span>,</span>
852<span id="cb12-21"><a href="#cb12-21" aria-hidden="true" tabindex="-1"></a> )</span>
853<span id="cb12-22"><a href="#cb12-22" aria-hidden="true" tabindex="-1"></a> <span class="cf">for</span> i <span class="kw">in</span> <span class="bu">range</span>(<span class="dv">1000</span>)</span>
854<span id="cb12-23"><a href="#cb12-23" aria-hidden="true" tabindex="-1"></a>]</span>
855<span id="cb12-24"><a href="#cb12-24" aria-hidden="true" tabindex="-1"></a></span>
856<span id="cb12-25"><a href="#cb12-25" aria-hidden="true" tabindex="-1"></a><span class="cf">with</span> wds.writer.TarWriter(<span class="st">"features.tar"</span>) <span class="im">as</span> sink:</span>
857<span id="cb12-26"><a href="#cb12-26" aria-hidden="true" tabindex="-1"></a> <span class="cf">for</span> i, s <span class="kw">in</span> <span class="bu">enumerate</span>(samples):</span>
858<span id="cb12-27"><a href="#cb12-27" aria-hidden="true" tabindex="-1"></a> sink.write({<span class="op">**</span>s.as_wds, <span class="st">"__key__"</span>: <span class="ss">f"</span><span class="sc">{</span>i<span class="sc">:06d}</span><span class="ss">"</span>})</span>
859<span id="cb12-28"><a href="#cb12-28" aria-hidden="true" tabindex="-1"></a></span>
860<span id="cb12-29"><a href="#cb12-29" aria-hidden="true" tabindex="-1"></a><span class="co"># 3. Store in local index with S3 backend</span></span>
861<span id="cb12-30"><a href="#cb12-30" aria-hidden="true" tabindex="-1"></a>store <span class="op">=</span> S3DataStore(credentials<span class="op">=</span><span class="st">"creds.env"</span>, bucket<span class="op">=</span><span class="st">"bucket"</span>)</span>
862<span id="cb12-31"><a href="#cb12-31" aria-hidden="true" tabindex="-1"></a>local_index <span class="op">=</span> LocalIndex(data_store<span class="op">=</span>store)</span>
863<span id="cb12-32"><a href="#cb12-32" aria-hidden="true" tabindex="-1"></a></span>
864<span id="cb12-33"><a href="#cb12-33" aria-hidden="true" tabindex="-1"></a>dataset <span class="op">=</span> atdata.Dataset[FeatureSample](<span class="st">"features.tar"</span>)</span>
865<span id="cb12-34"><a href="#cb12-34" aria-hidden="true" tabindex="-1"></a>local_entry <span class="op">=</span> local_index.insert_dataset(dataset, name<span class="op">=</span><span class="st">"feature-vectors-v1"</span>, prefix<span class="op">=</span><span class="st">"features"</span>)</span>
866<span id="cb12-35"><a href="#cb12-35" aria-hidden="true" tabindex="-1"></a></span>
867<span id="cb12-36"><a href="#cb12-36" aria-hidden="true" tabindex="-1"></a><span class="co"># 4. Publish schema locally</span></span>
868<span id="cb12-37"><a href="#cb12-37" aria-hidden="true" tabindex="-1"></a>local_index.publish_schema(FeatureSample, version<span class="op">=</span><span class="st">"1.0.0"</span>)</span>
869<span id="cb12-38"><a href="#cb12-38" aria-hidden="true" tabindex="-1"></a></span>
870<span id="cb12-39"><a href="#cb12-39" aria-hidden="true" tabindex="-1"></a><span class="co"># 5. Promote to atmosphere</span></span>
871<span id="cb12-40"><a href="#cb12-40" aria-hidden="true" tabindex="-1"></a>client <span class="op">=</span> AtmosphereClient()</span>
872<span id="cb12-41"><a href="#cb12-41" aria-hidden="true" tabindex="-1"></a>client.login(<span class="st">"myhandle.bsky.social"</span>, <span class="st">"app-password"</span>)</span>
873<span id="cb12-42"><a href="#cb12-42" aria-hidden="true" tabindex="-1"></a></span>
874<span id="cb12-43"><a href="#cb12-43" aria-hidden="true" tabindex="-1"></a>at_uri <span class="op">=</span> promote_to_atmosphere(</span>
875<span id="cb12-44"><a href="#cb12-44" aria-hidden="true" tabindex="-1"></a> local_entry,</span>
876<span id="cb12-45"><a href="#cb12-45" aria-hidden="true" tabindex="-1"></a> local_index,</span>
877<span id="cb12-46"><a href="#cb12-46" aria-hidden="true" tabindex="-1"></a> client,</span>
878<span id="cb12-47"><a href="#cb12-47" aria-hidden="true" tabindex="-1"></a> description<span class="op">=</span><span class="st">"Feature vectors for classification"</span>,</span>
879<span id="cb12-48"><a href="#cb12-48" aria-hidden="true" tabindex="-1"></a> tags<span class="op">=</span>[<span class="st">"features"</span>, <span class="st">"embeddings"</span>],</span>
880<span id="cb12-49"><a href="#cb12-49" aria-hidden="true" tabindex="-1"></a> license<span class="op">=</span><span class="st">"MIT"</span>,</span>
881<span id="cb12-50"><a href="#cb12-50" aria-hidden="true" tabindex="-1"></a>)</span>
882<span id="cb12-51"><a href="#cb12-51" aria-hidden="true" tabindex="-1"></a></span>
883<span id="cb12-52"><a href="#cb12-52" aria-hidden="true" tabindex="-1"></a><span class="bu">print</span>(<span class="ss">f"Dataset published: </span><span class="sc">{</span>at_uri<span class="sc">}</span><span class="ss">"</span>)</span>
884<span id="cb12-53"><a href="#cb12-53" aria-hidden="true" tabindex="-1"></a></span>
885<span id="cb12-54"><a href="#cb12-54" aria-hidden="true" tabindex="-1"></a><span class="co"># 6. Others can now discover and load</span></span>
886<span id="cb12-55"><a href="#cb12-55" aria-hidden="true" tabindex="-1"></a><span class="co"># ds = atdata.load_dataset("@myhandle.bsky.social/feature-vectors-v1")</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
887</div>
888</section>
889<section id="what-youve-learned" class="level2">
890<h2 class="anchored" data-anchor-id="what-youve-learned">What You’ve Learned</h2>
891<p>You now understand the promotion workflow:</p>
892<table class="caption-top table">
893<colgroup>
894<col style="width: 50%">
895<col style="width: 50%">
896</colgroup>
897<thead>
898<tr class="header">
899<th>Concept</th>
900<th>Purpose</th>
901</tr>
902</thead>
903<tbody>
904<tr class="odd">
905<td><code>promote_to_atmosphere()</code></td>
906<td>Lift local entries to federated network</td>
907</tr>
908<tr class="even">
909<td>Schema deduplication</td>
910<td>Avoid publishing duplicate schemas</td>
911</tr>
912<tr class="odd">
913<td>Data URL preservation</td>
914<td>Keep data in place or copy to new storage</td>
915</tr>
916<tr class="even">
917<td>Metadata enrichment</td>
918<td>Add description, tags, license during promotion</td>
919</tr>
920</tbody>
921</table>
922<p>Promotion completes atdata’s three-layer story: you can now move seamlessly from local experimentation to team collaboration to public sharing, all with the same typed sample definitions.</p>
923</section>
924<section id="the-complete-journey" class="level2">
925<h2 class="anchored" data-anchor-id="the-complete-journey">The Complete Journey</h2>
926<pre><code>┌──────────────────┐ insert ┌──────────────────┐ promote ┌──────────────────┐
927│ Local Files │ ────────────→ │ Team Storage │ ────────────→ │ Federation │
928│ │ │ │ │ │
929│ tar files │ │ Redis + S3 │ │ ATProto PDS │
930│ Dataset[T] │ │ LocalIndex │ │ AtmosphereIndex │
931└──────────────────┘ └──────────────────┘ └──────────────────┘</code></pre>
932</section>
933<section id="next-steps" class="level2">
934<h2 class="anchored" data-anchor-id="next-steps">Next Steps</h2>
935<ul>
936<li><strong><a href="../reference/atmosphere.html">Atmosphere Reference</a></strong> - Complete atmosphere API</li>
937<li><strong><a href="../reference/protocols.html">Protocols</a></strong> - Abstract interfaces</li>
938<li><strong><a href="../reference/local-storage.html">Local Storage</a></strong> - Local storage reference</li>
939</ul>
940
941
942</section>
943
944</main> <!-- /main -->
945<script id="quarto-html-after-body" type="application/javascript">
946 window.document.addEventListener("DOMContentLoaded", function (event) {
947 // Ensure there is a toggle, if there isn't float one in the top right
948 if (window.document.querySelector('.quarto-color-scheme-toggle') === null) {
949 const a = window.document.createElement('a');
950 a.classList.add('top-right');
951 a.classList.add('quarto-color-scheme-toggle');
952 a.href = "";
953 a.onclick = function() { try { window.quartoToggleColorScheme(); } catch {} return false; };
954 const i = window.document.createElement("i");
955 i.classList.add('bi');
956 a.appendChild(i);
957 window.document.body.appendChild(a);
958 }
959 setColorSchemeToggle(hasAlternateSentinel())
960 const icon = "";
961 const anchorJS = new window.AnchorJS();
962 anchorJS.options = {
963 placement: 'right',
964 icon: icon
965 };
966 anchorJS.add('.anchored');
967 const isCodeAnnotation = (el) => {
968 for (const clz of el.classList) {
969 if (clz.startsWith('code-annotation-')) {
970 return true;
971 }
972 }
973 return false;
974 }
975 const onCopySuccess = function(e) {
976 // button target
977 const button = e.trigger;
978 // don't keep focus
979 button.blur();
980 // flash "checked"
981 button.classList.add('code-copy-button-checked');
982 var currentTitle = button.getAttribute("title");
983 button.setAttribute("title", "Copied!");
984 let tooltip;
985 if (window.bootstrap) {
986 button.setAttribute("data-bs-toggle", "tooltip");
987 button.setAttribute("data-bs-placement", "left");
988 button.setAttribute("data-bs-title", "Copied!");
989 tooltip = new bootstrap.Tooltip(button,
990 { trigger: "manual",
991 customClass: "code-copy-button-tooltip",
992 offset: [0, -8]});
993 tooltip.show();
994 }
995 setTimeout(function() {
996 if (tooltip) {
997 tooltip.hide();
998 button.removeAttribute("data-bs-title");
999 button.removeAttribute("data-bs-toggle");
1000 button.removeAttribute("data-bs-placement");
1001 }
1002 button.setAttribute("title", currentTitle);
1003 button.classList.remove('code-copy-button-checked');
1004 }, 1000);
1005 // clear code selection
1006 e.clearSelection();
1007 }
1008 const getTextToCopy = function(trigger) {
1009 const codeEl = trigger.previousElementSibling.cloneNode(true);
1010 for (const childEl of codeEl.children) {
1011 if (isCodeAnnotation(childEl)) {
1012 childEl.remove();
1013 }
1014 }
1015 return codeEl.innerText;
1016 }
1017 const clipboard = new window.ClipboardJS('.code-copy-button:not([data-in-quarto-modal])', {
1018 text: getTextToCopy
1019 });
1020 clipboard.on('success', onCopySuccess);
1021 if (window.document.getElementById('quarto-embedded-source-code-modal')) {
1022 const clipboardModal = new window.ClipboardJS('.code-copy-button[data-in-quarto-modal]', {
1023 text: getTextToCopy,
1024 container: window.document.getElementById('quarto-embedded-source-code-modal')
1025 });
1026 clipboardModal.on('success', onCopySuccess);
1027 }
1028 var localhostRegex = new RegExp(/^(?:http|https):\/\/localhost\:?[0-9]*\//);
1029 var mailtoRegex = new RegExp(/^mailto:/);
1030 var filterRegex = new RegExp("https:\/\/github\.com\/your-org\/atdata");
1031 var isInternal = (href) => {
1032 return filterRegex.test(href) || localhostRegex.test(href) || mailtoRegex.test(href);
1033 }
1034 // Inspect non-navigation links and adorn them if external
1035 var links = window.document.querySelectorAll('a[href]:not(.nav-link):not(.navbar-brand):not(.toc-action):not(.sidebar-link):not(.sidebar-item-toggle):not(.pagination-link):not(.no-external):not([aria-hidden]):not(.dropdown-item):not(.quarto-navigation-tool):not(.about-link)');
1036 for (var i=0; i<links.length; i++) {
1037 const link = links[i];
1038 if (!isInternal(link.href)) {
1039 // undo the damage that might have been done by quarto-nav.js in the case of
1040 // links that we want to consider external
1041 if (link.dataset.originalHref !== undefined) {
1042 link.href = link.dataset.originalHref;
1043 }
1044 }
1045 }
1046 function tippyHover(el, contentFn, onTriggerFn, onUntriggerFn) {
1047 const config = {
1048 allowHTML: true,
1049 maxWidth: 500,
1050 delay: 100,
1051 arrow: false,
1052 appendTo: function(el) {
1053 return el.parentElement;
1054 },
1055 interactive: true,
1056 interactiveBorder: 10,
1057 theme: 'quarto',
1058 placement: 'bottom-start',
1059 };
1060 if (contentFn) {
1061 config.content = contentFn;
1062 }
1063 if (onTriggerFn) {
1064 config.onTrigger = onTriggerFn;
1065 }
1066 if (onUntriggerFn) {
1067 config.onUntrigger = onUntriggerFn;
1068 }
1069 window.tippy(el, config);
1070 }
1071 const noterefs = window.document.querySelectorAll('a[role="doc-noteref"]');
1072 for (var i=0; i<noterefs.length; i++) {
1073 const ref = noterefs[i];
1074 tippyHover(ref, function() {
1075 // use id or data attribute instead here
1076 let href = ref.getAttribute('data-footnote-href') || ref.getAttribute('href');
1077 try { href = new URL(href).hash; } catch {}
1078 const id = href.replace(/^#\/?/, "");
1079 const note = window.document.getElementById(id);
1080 if (note) {
1081 return note.innerHTML;
1082 } else {
1083 return "";
1084 }
1085 });
1086 }
1087 const xrefs = window.document.querySelectorAll('a.quarto-xref');
1088 const processXRef = (id, note) => {
1089 // Strip column container classes
1090 const stripColumnClz = (el) => {
1091 el.classList.remove("page-full", "page-columns");
1092 if (el.children) {
1093 for (const child of el.children) {
1094 stripColumnClz(child);
1095 }
1096 }
1097 }
1098 stripColumnClz(note)
1099 if (id === null || id.startsWith('sec-')) {
1100 // Special case sections, only their first couple elements
1101 const container = document.createElement("div");
1102 if (note.children && note.children.length > 2) {
1103 container.appendChild(note.children[0].cloneNode(true));
1104 for (let i = 1; i < note.children.length; i++) {
1105 const child = note.children[i];
1106 if (child.tagName === "P" && child.innerText === "") {
1107 continue;
1108 } else {
1109 container.appendChild(child.cloneNode(true));
1110 break;
1111 }
1112 }
1113 if (window.Quarto?.typesetMath) {
1114 window.Quarto.typesetMath(container);
1115 }
1116 return container.innerHTML
1117 } else {
1118 if (window.Quarto?.typesetMath) {
1119 window.Quarto.typesetMath(note);
1120 }
1121 return note.innerHTML;
1122 }
1123 } else {
1124 // Remove any anchor links if they are present
1125 const anchorLink = note.querySelector('a.anchorjs-link');
1126 if (anchorLink) {
1127 anchorLink.remove();
1128 }
1129 if (window.Quarto?.typesetMath) {
1130 window.Quarto.typesetMath(note);
1131 }
1132 if (note.classList.contains("callout")) {
1133 return note.outerHTML;
1134 } else {
1135 return note.innerHTML;
1136 }
1137 }
1138 }
1139 for (var i=0; i<xrefs.length; i++) {
1140 const xref = xrefs[i];
1141 tippyHover(xref, undefined, function(instance) {
1142 instance.disable();
1143 let url = xref.getAttribute('href');
1144 let hash = undefined;
1145 if (url.startsWith('#')) {
1146 hash = url;
1147 } else {
1148 try { hash = new URL(url).hash; } catch {}
1149 }
1150 if (hash) {
1151 const id = hash.replace(/^#\/?/, "");
1152 const note = window.document.getElementById(id);
1153 if (note !== null) {
1154 try {
1155 const html = processXRef(id, note.cloneNode(true));
1156 instance.setContent(html);
1157 } finally {
1158 instance.enable();
1159 instance.show();
1160 }
1161 } else {
1162 // See if we can fetch this
1163 fetch(url.split('#')[0])
1164 .then(res => res.text())
1165 .then(html => {
1166 const parser = new DOMParser();
1167 const htmlDoc = parser.parseFromString(html, "text/html");
1168 const note = htmlDoc.getElementById(id);
1169 if (note !== null) {
1170 const html = processXRef(id, note);
1171 instance.setContent(html);
1172 }
1173 }).finally(() => {
1174 instance.enable();
1175 instance.show();
1176 });
1177 }
1178 } else {
1179 // See if we can fetch a full url (with no hash to target)
1180 // This is a special case and we should probably do some content thinning / targeting
1181 fetch(url)
1182 .then(res => res.text())
1183 .then(html => {
1184 const parser = new DOMParser();
1185 const htmlDoc = parser.parseFromString(html, "text/html");
1186 const note = htmlDoc.querySelector('main.content');
1187 if (note !== null) {
1188 // This should only happen for chapter cross references
1189 // (since there is no id in the URL)
1190 // remove the first header
1191 if (note.children.length > 0 && note.children[0].tagName === "HEADER") {
1192 note.children[0].remove();
1193 }
1194 const html = processXRef(null, note);
1195 instance.setContent(html);
1196 }
1197 }).finally(() => {
1198 instance.enable();
1199 instance.show();
1200 });
1201 }
1202 }, function(instance) {
1203 });
1204 }
1205 let selectedAnnoteEl;
1206 const selectorForAnnotation = ( cell, annotation) => {
1207 let cellAttr = 'data-code-cell="' + cell + '"';
1208 let lineAttr = 'data-code-annotation="' + annotation + '"';
1209 const selector = 'span[' + cellAttr + '][' + lineAttr + ']';
1210 return selector;
1211 }
1212 const selectCodeLines = (annoteEl) => {
1213 const doc = window.document;
1214 const targetCell = annoteEl.getAttribute("data-target-cell");
1215 const targetAnnotation = annoteEl.getAttribute("data-target-annotation");
1216 const annoteSpan = window.document.querySelector(selectorForAnnotation(targetCell, targetAnnotation));
1217 const lines = annoteSpan.getAttribute("data-code-lines").split(",");
1218 const lineIds = lines.map((line) => {
1219 return targetCell + "-" + line;
1220 })
1221 let top = null;
1222 let height = null;
1223 let parent = null;
1224 if (lineIds.length > 0) {
1225 //compute the position of the single el (top and bottom and make a div)
1226 const el = window.document.getElementById(lineIds[0]);
1227 top = el.offsetTop;
1228 height = el.offsetHeight;
1229 parent = el.parentElement.parentElement;
1230 if (lineIds.length > 1) {
1231 const lastEl = window.document.getElementById(lineIds[lineIds.length - 1]);
1232 const bottom = lastEl.offsetTop + lastEl.offsetHeight;
1233 height = bottom - top;
1234 }
1235 if (top !== null && height !== null && parent !== null) {
1236 // cook up a div (if necessary) and position it
1237 let div = window.document.getElementById("code-annotation-line-highlight");
1238 if (div === null) {
1239 div = window.document.createElement("div");
1240 div.setAttribute("id", "code-annotation-line-highlight");
1241 div.style.position = 'absolute';
1242 parent.appendChild(div);
1243 }
1244 div.style.top = top - 2 + "px";
1245 div.style.height = height + 4 + "px";
1246 div.style.left = 0;
1247 let gutterDiv = window.document.getElementById("code-annotation-line-highlight-gutter");
1248 if (gutterDiv === null) {
1249 gutterDiv = window.document.createElement("div");
1250 gutterDiv.setAttribute("id", "code-annotation-line-highlight-gutter");
1251 gutterDiv.style.position = 'absolute';
1252 const codeCell = window.document.getElementById(targetCell);
1253 const gutter = codeCell.querySelector('.code-annotation-gutter');
1254 gutter.appendChild(gutterDiv);
1255 }
1256 gutterDiv.style.top = top - 2 + "px";
1257 gutterDiv.style.height = height + 4 + "px";
1258 }
1259 selectedAnnoteEl = annoteEl;
1260 }
1261 };
1262 const unselectCodeLines = () => {
1263 const elementsIds = ["code-annotation-line-highlight", "code-annotation-line-highlight-gutter"];
1264 elementsIds.forEach((elId) => {
1265 const div = window.document.getElementById(elId);
1266 if (div) {
1267 div.remove();
1268 }
1269 });
1270 selectedAnnoteEl = undefined;
1271 };
1272 // Handle positioning of the toggle
1273 window.addEventListener(
1274 "resize",
1275 throttle(() => {
1276 elRect = undefined;
1277 if (selectedAnnoteEl) {
1278 selectCodeLines(selectedAnnoteEl);
1279 }
1280 }, 10)
1281 );
1282 function throttle(fn, ms) {
1283 let throttle = false;
1284 let timer;
1285 return (...args) => {
1286 if(!throttle) { // first call gets through
1287 fn.apply(this, args);
1288 throttle = true;
1289 } else { // all the others get throttled
1290 if(timer) clearTimeout(timer); // cancel #2
1291 timer = setTimeout(() => {
1292 fn.apply(this, args);
1293 timer = throttle = false;
1294 }, ms);
1295 }
1296 };
1297 }
1298 // Attach click handler to the DT
1299 const annoteDls = window.document.querySelectorAll('dt[data-target-cell]');
1300 for (const annoteDlNode of annoteDls) {
1301 annoteDlNode.addEventListener('click', (event) => {
1302 const clickedEl = event.target;
1303 if (clickedEl !== selectedAnnoteEl) {
1304 unselectCodeLines();
1305 const activeEl = window.document.querySelector('dt[data-target-cell].code-annotation-active');
1306 if (activeEl) {
1307 activeEl.classList.remove('code-annotation-active');
1308 }
1309 selectCodeLines(clickedEl);
1310 clickedEl.classList.add('code-annotation-active');
1311 } else {
1312 // Unselect the line
1313 unselectCodeLines();
1314 clickedEl.classList.remove('code-annotation-active');
1315 }
1316 });
1317 }
1318 const findCites = (el) => {
1319 const parentEl = el.parentElement;
1320 if (parentEl) {
1321 const cites = parentEl.dataset.cites;
1322 if (cites) {
1323 return {
1324 el,
1325 cites: cites.split(' ')
1326 };
1327 } else {
1328 return findCites(el.parentElement)
1329 }
1330 } else {
1331 return undefined;
1332 }
1333 };
1334 var bibliorefs = window.document.querySelectorAll('a[role="doc-biblioref"]');
1335 for (var i=0; i<bibliorefs.length; i++) {
1336 const ref = bibliorefs[i];
1337 const citeInfo = findCites(ref);
1338 if (citeInfo) {
1339 tippyHover(citeInfo.el, function() {
1340 var popup = window.document.createElement('div');
1341 citeInfo.cites.forEach(function(cite) {
1342 var citeDiv = window.document.createElement('div');
1343 citeDiv.classList.add('hanging-indent');
1344 citeDiv.classList.add('csl-entry');
1345 var biblioDiv = window.document.getElementById('ref-' + cite);
1346 if (biblioDiv) {
1347 citeDiv.innerHTML = biblioDiv.innerHTML;
1348 }
1349 popup.appendChild(citeDiv);
1350 });
1351 return popup.innerHTML;
1352 });
1353 }
1354 }
1355 });
1356 </script>
1357</div> <!-- /content -->
1358<footer class="footer">
1359 <div class="nav-footer">
1360 <div class="nav-footer-left">
1361<p>Built with <a href="https://quarto.org/">Quarto</a></p>
1362</div>
1363 <div class="nav-footer-center">
1364
1365 <div class="toc-actions d-sm-block d-md-none"><ul><li><a href="https://github.com/your-org/atdata/edit/main/tutorials/promotion.qmd" class="toc-action"><i class="bi bi-github"></i>Edit this page</a></li><li><a href="https://github.com/your-org/atdata/issues/new" class="toc-action"><i class="bi empty"></i>Report an issue</a></li></ul></div></div>
1366 <div class="nav-footer-right">
1367<p>MIT License</p>
1368</div>
1369 </div>
1370</footer>
1371
1372
1373
1374
1375</body></html>