Skip to content

Commit

Permalink
build based on 09b49bb
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Apr 29, 2024
1 parent 2983ad1 commit 6dbbc8c
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-04-29T20:42:15","documenter_version":"1.4.0"}}
{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-04-29T21:14:55","documenter_version":"1.4.0"}}
6 changes: 3 additions & 3 deletions dev/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · ZarrDatasets.jl</title><meta name="title" content="Home · ZarrDatasets.jl"/><meta property="og:title" content="Home · ZarrDatasets.jl"/><meta property="twitter:title" content="Home · ZarrDatasets.jl"/><meta name="description" content="Documentation for ZarrDatasets.jl."/><meta property="og:description" content="Documentation for ZarrDatasets.jl."/><meta property="twitter:description" content="Documentation for ZarrDatasets.jl."/><meta property="og:url" content="https://juliageo.github.io/ZarrDatasets.jl/"/><meta property="twitter:url" content="https://juliageo.github.io/ZarrDatasets.jl/"/><link rel="canonical" href="https://juliageo.github.io/ZarrDatasets.jl/"/><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="search_index.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href>ZarrDatasets.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Home</a><ul class="internal"><li><a class="tocitem" href="#ZarrDatasets"><span>ZarrDatasets</span></a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaGeo/ZarrDatasets.jl/blob/main/docs/src/index.md#" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h2 id="ZarrDatasets"><a class="docs-heading-anchor" href="#ZarrDatasets">ZarrDatasets</a><a id="ZarrDatasets-1"></a><a class="docs-heading-anchor-permalink" href="#ZarrDatasets" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="ZarrDatasets.ZarrDataset" href="#ZarrDatasets.ZarrDataset"><code>ZarrDatasets.ZarrDataset</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">ds = ZarrDataset(url::AbstractString,mode = &quot;r&quot;;
_omitcode = 404,
_omitcode = [404,403],
maskingvalue = missing)
ZarrDataset(f::Function,url::AbstractString,mode = &quot;r&quot;;
maskingvalue = missing)</code></pre><p>Open the zarr dataset at the url or path <code>url</code>. Only the read-mode is currently supported. <code>ds</code> supports the API of the <a href="https://github.com/JuliaGeo/CommonDataModel.jl">JuliaGeo/CommonDataModel.jl</a>. The experimental <code>_omitcode</code> allows to work-around servers that return HTTP error different than 404 for missing chunks.</p><p>Example:</p><pre><code class="language-julia hljs">using ZarrDatasets
maskingvalue = missing)</code></pre><p>Open the zarr dataset at the url or path <code>url</code>. The mode can only be &quot;r&quot; (read-only) or &quot;c&quot; (create). <code>ds</code> supports the API of the <a href="https://github.com/JuliaGeo/CommonDataModel.jl">JuliaGeo/CommonDataModel.jl</a>. The experimental <code>_omitcode</code> allows to work-around servers that return a HTTP error different than 404 for missing chunks.</p><p>Example:</p><pre><code class="language-julia hljs">using ZarrDatasets
url = &quot;https://s3.waw3-1.cloudferro.com/mdl-arco-time-035/arco/MEDSEA_MULTIYEAR_PHY_006_004/med-cmcc-ssh-rean-d_202012/timeChunked.zarr&quot;
ds = ZarrDataset(url);
# see the metadata
Expand All @@ -21,4 +21,4 @@

zos1 = ZarrDataset(url) do ds
ds[&quot;zos&quot;][:,:,end,1]
end # implicit call to close(ds)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGeo/ZarrDatasets.jl/blob/0d427c9880bade131acadf157618894831f3c750/src/dataset.jl#L62-L105">source</a></section></article><h3 id="Differences-between-Zarr-and-NetCDF-files"><a class="docs-heading-anchor" href="#Differences-between-Zarr-and-NetCDF-files">Differences between Zarr and NetCDF files</a><a id="Differences-between-Zarr-and-NetCDF-files-1"></a><a class="docs-heading-anchor-permalink" href="#Differences-between-Zarr-and-NetCDF-files" title="Permalink"></a></h3><ul><li>All metadata (in particular attributes) is stored in JSON files for the Zarr format with the following implications:<ul><li>JSON does not distinguish between integers and real numbers. They are all considered as generic numbers. Whole numbers are loaded as <code>Int64</code> and decimal numbers <code>Float64</code>. It is not possible to store the number <code>1.0</code> as a real number.</li><li>The order of keys in a JSON document is undefined. It is therefore not possible to have a consistent ordering of the attributes or variables.</li><li>The JSON standard does not allow NaN, +Inf, -Inf (https://github.com/capnproto/capnproto/issues/261).</li></ul></li></ul></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.0 on <span class="colophon-date" title="Monday 29 April 2024 20:42">Monday 29 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
end # implicit call to close(ds)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGeo/ZarrDatasets.jl/blob/09b49bb87c19c6182a3cc3d9c6f1969d3805a205/src/dataset.jl#L62-L105">source</a></section></article><h3 id="Differences-between-Zarr-and-NetCDF-files"><a class="docs-heading-anchor" href="#Differences-between-Zarr-and-NetCDF-files">Differences between Zarr and NetCDF files</a><a id="Differences-between-Zarr-and-NetCDF-files-1"></a><a class="docs-heading-anchor-permalink" href="#Differences-between-Zarr-and-NetCDF-files" title="Permalink"></a></h3><ul><li>All metadata (in particular attributes) is stored in JSON files for the Zarr format with the following implications:<ul><li>JSON does not distinguish between integers and real numbers. They are all considered as generic numbers. Whole numbers are loaded as <code>Int64</code> and real numbers <code>Float64</code>. It is not possible to store the number <code>1.0</code> as a real number.</li><li>The order of keys in a JSON document is undefined. It is therefore not possible to have a consistent ordering of the attributes or variables.</li><li>The JSON standard does not allow the values NaN, +Inf, -Inf which is problematic for attributes (<a href="https://github.com/zarr-developers/zarr-python/issues/412">zarr-python #412</a>,</li></ul><a href="https://github.com/zarr-developers/zarr-specs/issues/81">zarr-specs #81</a>). However, there is a special case for the fill-value to handle NaN, +Inf and -Inf.</li></ul></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.0 on <span class="colophon-date" title="Monday 29 April 2024 21:14">Monday 29 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/search_index.js
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 6dbbc8c

Please sign in to comment.