[{"data":1,"prerenderedAt":514},["ShallowReactive",2],{"navigation_docs":3,"-pybrowzarr-build-and-update":159,"-pybrowzarr-build-and-update-surround":509},[4,25,60,85,120,135],{"title":5,"icon":6,"path":7,"stem":8,"children":9,"page":6},"Getting Started",false,"\u002Fgetting-started","1.getting-started",[10,15,20],{"title":11,"path":12,"stem":13,"icon":14},"Introduction","\u002Fgetting-started\u002Fintroduction","1.getting-started\u002F1.introduction","i-lucide-soup",{"title":16,"path":17,"stem":18,"icon":19},"Installation","\u002Fgetting-started\u002Finstallation","1.getting-started\u002F2.installation","i-lucide-download",{"title":21,"path":22,"stem":23,"icon":24},"Crash Course","\u002Fgetting-started\u002Flanding","1.getting-started\u002F3.landing","i-lucide-plane-landing",{"title":26,"path":27,"stem":28,"children":29,"page":6},"Menus","\u002Fmenus","2.Menus",[30,35,40,45,50,55],{"title":31,"path":32,"stem":33,"icon":34},"Dataset loading","\u002Fmenus\u002Fdataset-loading","2.Menus\u002F1.dataset-loading","i-lucide-database",{"title":36,"path":37,"stem":38,"icon":39},"Variable selection","\u002Fmenus\u002Fvariable-selection","2.Menus\u002F2.variable-selection","i-lucide-variable",{"title":41,"path":42,"stem":43,"icon":44},"Plot types","\u002Fmenus\u002Fplot-types","2.Menus\u002F3.plot-types","i-lucide-chart-scatter",{"title":46,"path":47,"stem":48,"icon":49},"Colorbar","\u002Fmenus\u002Fcolorbar","2.Menus\u002F4.colorbar","i-lucide-paint-bucket",{"title":51,"path":52,"stem":53,"icon":54},"Plot settings","\u002Fmenus\u002Fplot-settings","2.Menus\u002F5.plot-settings","i-heroicons-adjustments-horizontal",{"title":56,"path":57,"stem":58,"icon":59},"Analytics","\u002Fmenus\u002Fanalytics","2.Menus\u002F6.analytics","i-ph-math-operations-bold",{"title":61,"icon":6,"path":62,"stem":63,"children":64,"page":6},"Guides","\u002Fguides","3.guides",[65,70,75,80],{"title":66,"path":67,"stem":68,"icon":69},"Remote data","\u002Fguides\u002Fremote-data","3.guides\u002F1.remote-data","i-lucide-cloud",{"title":71,"path":72,"stem":73,"icon":74},"Local data","\u002Fguides\u002Flocal-data","3.guides\u002F2.local-data","i-lucide-hard-drive",{"title":76,"path":77,"stem":78,"icon":79},"Bivariate colormaps","\u002Fguides\u002Fbivariate-colormaps","3.guides\u002F3.bivariate-colormaps","i-lucide-palette",{"title":81,"path":82,"stem":83,"icon":84},"Animation and export","\u002Fguides\u002Fanimation-and-export","3.guides\u002F4.animation-and-export","i-lucide-image",{"title":86,"icon":6,"path":87,"stem":88,"children":89,"page":6},"pyBrowzarr","\u002Fpybrowzarr","4.pyBrowzarr",[90,95,100,105,110,115],{"title":91,"path":92,"stem":93,"icon":94},"Overview","\u002Fpybrowzarr\u002Foverview","4.pyBrowzarr\u002F1.overview","i-lucide-terminal",{"title":96,"path":97,"stem":98,"icon":99},"Quickstart","\u002Fpybrowzarr\u002Fquickstart","4.pyBrowzarr\u002F2.quickstart","i-lucide-rocket",{"title":101,"path":102,"stem":103,"icon":104},"Export & Animation","\u002Fpybrowzarr\u002Fexport","4.pyBrowzarr\u002F4.export","i-lucide-clapperboard",{"title":106,"path":107,"stem":108,"icon":109},"Environments","\u002Fpybrowzarr\u002Fenvironment","4.pyBrowzarr\u002F5.environment","i-lucide-monitor",{"title":111,"path":112,"stem":113,"icon":114},"Build & Update","\u002Fpybrowzarr\u002Fbuild-and-update","4.pyBrowzarr\u002F6.build-and-update","i-lucide-refresh-cw",{"title":116,"path":117,"stem":118,"icon":119},"API Reference","\u002Fpybrowzarr\u002Fapi-reference","4.pyBrowzarr\u002F7.api-reference","i-lucide-book-open",{"title":121,"icon":6,"path":122,"stem":123,"children":124,"page":6},"Community","\u002Fcommunity","5.community",[125,130],{"title":126,"path":127,"stem":128,"icon":129},"Contributing","\u002Fcommunity\u002Fcontributing","5.community\u002F1.contributing","i-lucide-git-pull-request-arrow",{"title":131,"path":132,"stem":133,"icon":134},"About","\u002Fcommunity\u002Fabout","5.community\u002F2.about","i-lucide-badge-info",{"title":136,"icon":6,"path":137,"stem":138,"children":139,"page":6},"Reference","\u002Freference","6.reference",[140,145,149,154],{"title":141,"path":142,"stem":143,"icon":144},"Supported formats","\u002Freference\u002Fsupported-formats","6.reference\u002F2.supported-formats","i-lucide-file-box",{"title":146,"path":147,"stem":148,"icon":109},"Browser support","\u002Freference\u002Fbrowser-support","6.reference\u002F3.browser-support",{"title":150,"path":151,"stem":152,"icon":153},"Troubleshooting","\u002Freference\u002Ftroubleshooting","6.reference\u002F4.troubleshooting","i-lucide-wrench",{"title":155,"path":156,"stem":157,"icon":158},"FAQ","\u002Freference\u002Ffaq","6.reference\u002F5.faq","i-lucide-message-circle-question",{"id":160,"title":111,"body":161,"description":502,"extension":503,"links":504,"meta":505,"navigation":506,"path":112,"seo":507,"stem":113,"__hash__":508},"docs\u002F4.pyBrowzarr\u002F6.build-and-update.md",{"type":162,"value":163,"toc":492},"minimark",[164,190,193,201,208,254,257,276,279,286,293,320,322,347,352,367,375,381,384,391,403,424,431,434,438,488],[165,166,167,168,172,173,177,178,181,182,189],"p",{},"The ",[169,170,171],"code",{},"browzarr"," package ships with a ",[174,175,176],"strong",{},"pre-built"," copy of the Browzarr web frontend in\n",[169,179,180],{},"web\u002Fdist",". That build is static — to pick up new features or fixes from the upstream\n",[183,184,188],"a",{"href":185,"rel":186},"https:\u002F\u002Fgithub.com\u002FEarthyScience\u002FBrowzarr",[187],"nofollow","Browzarr"," project, rebuild or update it.",[165,191,192],{},"There are two ways to do this, each suited to a different situation.",[194,195,197,200],"h2",{"id":196},"update_browzarr-quick-prebuilt-update-preferred",[169,198,199],{},"update_browzarr()"," — quick prebuilt update (preferred)",[165,202,203,204,207],{},"Downloads a pre-built distribution from the upstream ",[169,205,206],{},"python-dist"," branch and swaps it\ninto the package. This is fast (no compile step) and the recommended way to stay current.",[209,210,215],"pre",{"className":211,"code":212,"language":213,"meta":214,"style":214},"language-python shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","from browzarr import update_browzarr\n\nupdate_browzarr()\n","python","",[169,216,217,236,243],{"__ignoreMap":214},[218,219,222,226,230,233],"span",{"class":220,"line":221},"line",1,[218,223,225],{"class":224},"s7zQu","from",[218,227,229],{"class":228},"sTEyZ"," browzarr ",[218,231,232],{"class":224},"import",[218,234,235],{"class":228}," update_browzarr\n",[218,237,239],{"class":220,"line":238},2,[218,240,242],{"emptyLinePlaceholder":241},true,"\n",[218,244,246,250],{"class":220,"line":245},3,[218,247,249],{"class":248},"s2Zo4","update_browzarr",[218,251,253],{"class":252},"sMK4o","()\n",[165,255,256],{},"What it does:",[258,259,260,267,270],"ol",{},[261,262,263,264,266],"li",{},"Downloads the ",[169,265,206],{}," tarball from GitHub.",[261,268,269],{},"Extracts it to a temporary directory.",[261,271,272,273,275],{},"Replaces the package's ",[169,274,180],{}," folder with the new build.",[165,277,278],{},"Requires an internet connection and write access to the package's data directory.",[194,280,282,285],{"id":281},"build_browzarr-rebuild-from-source",[169,283,284],{},"build_browzarr()"," — rebuild from source",[165,287,288,289,292],{},"Compiles the frontend from the latest upstream ",[169,290,291],{},"main"," source. Use this when you want the\nvery newest code or are contributing to the frontend itself.",[209,294,296],{"className":211,"code":295,"language":213,"meta":214,"style":214},"from browzarr import build_browzarr\n\nbuild_browzarr()\n",[169,297,298,309,313],{"__ignoreMap":214},[218,299,300,302,304,306],{"class":220,"line":221},[218,301,225],{"class":224},[218,303,229],{"class":228},[218,305,232],{"class":224},[218,307,308],{"class":228}," build_browzarr\n",[218,310,311],{"class":220,"line":238},[218,312,242],{"emptyLinePlaceholder":241},[218,314,315,318],{"class":220,"line":245},[218,316,317],{"class":248},"build_browzarr",[218,319,253],{"class":252},[165,321,256],{},[258,323,324,330,341],{},[261,325,326,327,329],{},"Downloads the latest source from the upstream ",[169,328,291],{}," branch.",[261,331,332,333,336,337,340],{},"Runs ",[169,334,335],{},"pnpm install"," and ",[169,338,339],{},"pnpm run build"," in a temporary directory.",[261,342,343,344,346],{},"Copies the built output into the package's ",[169,345,180],{}," folder.",[348,349,351],"h3",{"id":350},"prerequisites","Prerequisites",[165,353,354,359,360,363,364,366],{},[183,355,358],{"href":356,"rel":357},"https:\u002F\u002Fpnpm.io\u002Finstallation",[187],"pnpm"," must be installed and available on your ",[169,361,362],{},"PATH",". If\nit isn't, ",[169,365,284],{}," prints an installation hint and stops:",[209,368,373],{"className":369,"code":371,"language":372},[370],"language-text","pnpm not installed. Install it then run again\nhttps:\u002F\u002Fpnpm.io\u002Finstallation\n","text",[169,374,371],{"__ignoreMap":214},[165,376,377,378,380],{},"The build is slower than ",[169,379,199],{}," because it compiles the frontend.",[194,382,150],{"id":383},"troubleshooting",[165,385,386],{},[174,387,388],{},[169,389,390],{},"No frontend build found in 'web\u002Fdist'",[165,392,393,394,396,397,399,400,402],{},"The package was installed without the bundled assets (or they were removed). Run\n",[169,395,199],{}," (fast) or ",[169,398,284],{}," (from source) to populate ",[169,401,180],{},":",[209,404,406],{"className":211,"code":405,"language":213,"meta":214,"style":214},"from browzarr import update_browzarr\nupdate_browzarr()\n",[169,407,408,418],{"__ignoreMap":214},[218,409,410,412,414,416],{"class":220,"line":221},[218,411,225],{"class":224},[218,413,229],{"class":228},[218,415,232],{"class":224},[218,417,235],{"class":228},[218,419,420,422],{"class":220,"line":238},[218,421,249],{"class":248},[218,423,253],{"class":252},[165,425,426],{},[174,427,428,429],{},"Permission errors when writing ",[169,430,180],{},[165,432,433],{},"Both functions write into the installed package's data directory. Make sure you have\nwrite access to that location, or run in an environment where the package is writable\n(e.g. a user site-packages install).",[194,435,437],{"id":436},"which-should-i-use","Which should I use?",[439,440,441,454],"table",{},[442,443,444],"thead",{},[445,446,447,451],"tr",{},[448,449,450],"th",{},"Situation",[448,452,453],{},"Use",[455,456,457,467,476],"tbody",{},[445,458,459,463],{},[460,461,462],"td",{},"Just want the latest stable frontend",[460,464,465],{},[169,466,199],{},[445,468,469,472],{},[460,470,471],{},"Want the newest in-development frontend",[460,473,474],{},[169,475,284],{},[445,477,478,484],{},[460,479,480,481,483],{},"Missing ",[169,482,180],{}," after install",[460,485,486],{},[169,487,199],{},[489,490,491],"style",{},"html pre.shiki code .s7zQu, html code.shiki .s7zQu{--shiki-light:#39ADB5;--shiki-light-font-style:italic;--shiki-default:#89DDFF;--shiki-default-font-style:italic;--shiki-dark:#89DDFF;--shiki-dark-font-style:italic}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":214,"searchDepth":238,"depth":238,"links":493},[494,496,500,501],{"id":196,"depth":238,"text":495},"update_browzarr() — quick prebuilt update (preferred)",{"id":281,"depth":238,"text":497,"children":498},"build_browzarr() — rebuild from source",[499],{"id":350,"depth":245,"text":351},{"id":383,"depth":238,"text":150},{"id":436,"depth":238,"text":437},"Update or rebuild the Browzarr frontend bundled with the pyBrowzarr package.","md",null,{},{"icon":114},{"title":111,"description":502},"R7gBJMb6VLkqqUBLCpgMJpCzV4o29t5fQay7Pc52qIM",[510,512],{"title":106,"path":107,"stem":108,"description":511,"icon":109,"children":-1},"How pyBrowzarr opens the Browzarr view in terminal, Jupyter, VS Code, and Colab.",{"title":116,"path":117,"stem":118,"description":513,"icon":119,"children":-1},"Full reference for the pyBrowzarr public API — Browzarr, its methods, module functions, and plot-type options.",1790773465223]