build based on bee2653

GeoRegionsEcosystem · Feb 20, 2024 · b135926 · b135926
1 parent 03fb485
commit b135926
Show file tree

Hide file tree

Showing 19 changed files with 58 additions and 58 deletions.
diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json
@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.1","generation_timestamp":"2024-02-20T03:37:17","documenter_version":"1.2.1"}}
+{"documenter":{"julia_version":"1.10.1","generation_timestamp":"2024-02-20T03:40:39","documenter_version":"1.2.1"}}
diff --git a/dev/components/datasets/cds.html b/dev/components/datasets/cds.html
diff --git a/dev/components/datasets/custom.html b/dev/components/datasets/custom.html
diff --git a/dev/components/datasets/define.html b/dev/components/datasets/define.html
diff --git a/dev/components/datasets/dummy.html b/dev/components/datasets/dummy.html
diff --git a/dev/components/datasets/overview.html b/dev/components/datasets/overview.html
@@ -1,4 +1,4 @@
 <!DOCTYPE html>
 <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>An Overview of ERA5 Datasets · ERA5Reanalysis.jl</title><meta name="title" content="An Overview of ERA5 Datasets · ERA5Reanalysis.jl"/><meta property="og:title" content="An Overview of ERA5 Datasets · ERA5Reanalysis.jl"/><meta property="twitter:title" content="An Overview of ERA5 Datasets · ERA5Reanalysis.jl"/><meta name="description" content="Documentation for ERA5Reanalysis.jl."/><meta property="og:description" content="Documentation for ERA5Reanalysis.jl."/><meta property="twitter:description" content="Documentation for ERA5Reanalysis.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="../../index.html">ERA5Reanalysis.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><a class="tocitem" href="../../index.html">Home</a></li><li><input class="collapse-toggle" id="menuitem-2" type="checkbox" checked/><label class="tocitem" for="menuitem-2"><span class="docs-label">Components</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../overview.html">Overview</a></li><li><input class="collapse-toggle" id="menuitem-2-2" type="checkbox" checked/><label class="tocitem" for="menuitem-2-2"><span class="docs-label">ERA5Datasets</span><i class="docs-chevron"></i></label><ul class="collapsed"><li class="is-active"><a class="tocitem" href="overview.html">An Overview of ERA5 Datasets</a></li><li><a class="tocitem" href="define.html">Defining ERA5 Datasets</a></li><li><a class="tocitem" href="cds.html">Climate Data Store Datasets</a></li><li><a class="tocitem" href="custom.html">Custom ERA5 Datasets</a></li><li><a class="tocitem" href="dummy.html">Dummy ERA5 Datasets</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-2-3" type="checkbox"/><label class="tocitem" for="menuitem-2-3"><span class="docs-label">ERA5Variables</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../variables/index.html">What is an ERA5 Variable</a></li><li><a class="tocitem" href="../variables/read.html">Retrieving Existing ERA5 Variables</a></li><li><a class="tocitem" href="../variables/custom.html">Creating Custom ERA5 Variables</a></li><li><a class="tocitem" href="../variables/reset.html">Resetting ERA5 Variables</a></li><li><a class="tocitem" href="../variables/list.html">Predefined ERA5 Variables</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-2-4" type="checkbox"/><label class="tocitem" for="menuitem-2-4"><span class="docs-label">ERA5Regions</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../regions/index.html">What is an ERA5Region</a></li><li><a class="tocitem" href="../regions/isin.html">Is it in an ERA5Region</a></li><li><a class="tocitem" href="../regions/gridded.html">Extracting Data for an ERA5Region</a></li></ul></li></ul></li><li><input class="collapse-toggle" id="menuitem-3" type="checkbox"/><label class="tocitem" for="menuitem-3"><span class="docs-label">Using ERA5Reanalysis.jl</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><input class="collapse-toggle" id="menuitem-3-1" type="checkbox"/><label class="tocitem" for="menuitem-3-1"><span class="docs-label">LandSea Datasets in ERA5</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../../using/landsea/intro.html">What is a LandSea Dataset</a></li><li><a class="tocitem" href="../../using/landsea/create.html">Downloading LandSea Datasets</a></li></ul></li><li><a class="tocitem" href="../../using/download.html">Downloading and Reading Data</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><a class="is-disabled">Components</a></li><li><a class="is-disabled">ERA5Datasets</a></li><li class="is-active"><a href="overview.html">An Overview of ERA5 Datasets</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="overview.html">An Overview of ERA5 Datasets</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/natgeo-wong/ERA5Reanalysis.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/natgeo-wong/ERA5Reanalysis.jl/blob/main/docs/src/components/datasets/overview.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"><h1 id="An-Overview-of-ERA5-Reanalysis-Datasets"><a class="docs-heading-anchor" href="#An-Overview-of-ERA5-Reanalysis-Datasets">An Overview of ERA5 Reanalysis Datasets</a><a id="An-Overview-of-ERA5-Reanalysis-Datasets-1"></a><a class="docs-heading-anchor-permalink" href="#An-Overview-of-ERA5-Reanalysis-Datasets" title="Permalink"></a></h1><p>An ERA5 Dataset is defined to be a module containing ERA5 Reanalysis data from the Climate Data Store, and is to distinguish between datasets with differing time-resolution, from hourly to monthly.</p><p>ERA5 reanalysis data is stored on the Climate Data Store in several different categories, so different people with different needs may access different data types depending on their research.  In ERA5Reanalysis, we defined these datasets as <code>ERA5Dataset</code> Types.</p><p>When defining an <code>ERA5Dataset</code> container, we also indicate the start and end dates of the dataset that we want to work on.</p><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="ERA5Reanalysis.ERA5Dataset" href="#ERA5Reanalysis.ERA5Dataset"><code>ERA5Reanalysis.ERA5Dataset</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">ERA5Dataset</code></pre><p>Abstract supertype for ERA5 reanalysis datasets, with the following subtypes:</p><pre><code class="nohighlight hljs">ERA5CDStore &lt;: ERA5Dataset
 ERA5Custom  &lt;: ERA5Dataset
-ERA5Dummy   &lt;: ERA5Dataset</code></pre><p>All <code>ERA5Dataset</code> Types contain the following fields:</p><ul><li><code>path</code> : The specified directory in which to save the data</li><li><code>emask</code> : The specified directory in which to save the <code>LandSea</code> dataset</li></ul><p>All <code>ERA5CDStore</code> and <code>ERA5Custom</code> Types also contain the following additional fields:</p><ul><li><code>ID</code> : The module ID, that also acts as a prefix to filenames</li><li><code>name</code> : The full name of the module</li><li><code>start</code> : The date for which downloads/analysis begins</li><li><code>stop</code> : The date for which downloads/analysis finishes</li><li><code>sldoi</code> : Single-Level DOI (N/A for ERA5Daily)</li><li><code>pldoi</code> : Pressure-Level DOI (N/A for ERA5Daily)</li><li><code>ptype</code> : Product type (N/A for ERA5Daily), set to <code>reanalysis</code></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/natgeo-wong/ERA5Reanalysis.jl/blob/43431ab5fbefc11c28a3c4679c34324d1713cf67/src/ERA5Reanalysis.jl#L55-L76">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../overview.html">« Overview</a><a class="docs-footer-nextpage" href="define.html">Defining ERA5 Datasets »</a><div class="flexbox-break"></div><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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Tuesday 20 February 2024 03:37">Tuesday 20 February 2024</span>. Using Julia version 1.10.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+ERA5Dummy   &lt;: ERA5Dataset</code></pre><p>All <code>ERA5Dataset</code> Types contain the following fields:</p><ul><li><code>path</code> : The specified directory in which to save the data</li><li><code>emask</code> : The specified directory in which to save the <code>LandSea</code> dataset</li></ul><p>All <code>ERA5CDStore</code> and <code>ERA5Custom</code> Types also contain the following additional fields:</p><ul><li><code>ID</code> : The module ID, that also acts as a prefix to filenames</li><li><code>name</code> : The full name of the module</li><li><code>start</code> : The date for which downloads/analysis begins</li><li><code>stop</code> : The date for which downloads/analysis finishes</li><li><code>sldoi</code> : Single-Level DOI (N/A for ERA5Daily)</li><li><code>pldoi</code> : Pressure-Level DOI (N/A for ERA5Daily)</li><li><code>ptype</code> : Product type (N/A for ERA5Daily), set to <code>reanalysis</code></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/natgeo-wong/ERA5Reanalysis.jl/blob/bee2653e3b09ebf96bf33339231b3e633bf12e25/src/ERA5Reanalysis.jl#L55-L76">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../overview.html">« Overview</a><a class="docs-footer-nextpage" href="define.html">Defining ERA5 Datasets »</a><div class="flexbox-break"></div><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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Tuesday 20 February 2024 03:40">Tuesday 20 February 2024</span>. Using Julia version 1.10.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		{"documenter":{"julia_version":"1.10.1","generation_timestamp":"2024-02-20T03:37:17","documenter_version":"1.2.1"}}
		{"documenter":{"julia_version":"1.10.1","generation_timestamp":"2024-02-20T03:40:39","documenter_version":"1.2.1"}}