Skip to content

merra2.rst #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
runyangxu merged 1 commit into from
Jan 29, 2026
Merged

merra2.rst #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 10 additions & 20 deletions docs/_modules/pyhazards/datasets/base.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,17 +206,7 @@
</ul>
<p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
<ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../pyhazards_datasets.html">Datasets</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Datasets</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../../../datasets/merra2.html">MERRA-2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../datasets/era5.html">ERA5</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../datasets/noaa_flood.html">NOAA Flood Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../datasets/firms.html">FIRMS</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../datasets/mtbs.html">MTBS</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../datasets/landfire.html">LANDFIRE</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../datasets/wfigs.html">WFIGS</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../datasets/goesr.html">GOES-R</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../../pyhazards_datasets.html">Datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../pyhazards_models.html">Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../pyhazards_engine.html">Engine</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../pyhazards_metrics.html">Metrics</a></li>
Expand Down Expand Up @@ -268,7 +258,7 @@ <h1>Source code for pyhazards.datasets.base</h1><div class="highlight"><pre>


<div class="viewcode-block" id="FeatureSpec">
<a class="viewcode-back" href="../../../api/pyhazards.datasets.html#pyhazards.FeatureSpec">[docs]</a>
<a class="viewcode-back" href="../../../api/pyhazards.datasets.html#pyhazards.datasets.base.FeatureSpec">[docs]</a>
<span class="nd">@dataclass</span>
<span class="k">class</span><span class="w"> </span><span class="nc">FeatureSpec</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Describes input features (shapes, dtypes, normalization).&quot;&quot;&quot;</span>
Expand All @@ -280,7 +270,7 @@ <h1>Source code for pyhazards.datasets.base</h1><div class="highlight"><pre>


<div class="viewcode-block" id="LabelSpec">
<a class="viewcode-back" href="../../../api/pyhazards.datasets.html#pyhazards.LabelSpec">[docs]</a>
<a class="viewcode-back" href="../../../api/pyhazards.datasets.html#pyhazards.datasets.base.LabelSpec">[docs]</a>
<span class="nd">@dataclass</span>
<span class="k">class</span><span class="w"> </span><span class="nc">LabelSpec</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Describes labels/targets for downstream tasks.&quot;&quot;&quot;</span>
Expand All @@ -292,7 +282,7 @@ <h1>Source code for pyhazards.datasets.base</h1><div class="highlight"><pre>


<div class="viewcode-block" id="DataSplit">
<a class="viewcode-back" href="../../../api/pyhazards.datasets.html#pyhazards.DataSplit">[docs]</a>
<a class="viewcode-back" href="../../../api/pyhazards.datasets.html#pyhazards.datasets.base.DataSplit">[docs]</a>
<span class="nd">@dataclass</span>
<span class="k">class</span><span class="w"> </span><span class="nc">DataSplit</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Container for a single split.&quot;&quot;&quot;</span>
Expand All @@ -303,7 +293,7 @@ <h1>Source code for pyhazards.datasets.base</h1><div class="highlight"><pre>


<div class="viewcode-block" id="DataBundle">
<a class="viewcode-back" href="../../../api/pyhazards.datasets.html#pyhazards.DataBundle">[docs]</a>
<a class="viewcode-back" href="../../../api/pyhazards.datasets.html#pyhazards.datasets.base.DataBundle">[docs]</a>
<span class="nd">@dataclass</span>
<span class="k">class</span><span class="w"> </span><span class="nc">DataBundle</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
Expand All @@ -316,7 +306,7 @@ <h1>Source code for pyhazards.datasets.base</h1><div class="highlight"><pre>
<span class="n">metadata</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span> <span class="o">=</span> <span class="n">field</span><span class="p">(</span><span class="n">default_factory</span><span class="o">=</span><span class="nb">dict</span><span class="p">)</span>

<div class="viewcode-block" id="DataBundle.get_split">
<a class="viewcode-back" href="../../../api/pyhazards.datasets.html#pyhazards.DataBundle.get_split">[docs]</a>
<a class="viewcode-back" href="../../../api/pyhazards.datasets.html#pyhazards.datasets.base.DataBundle.get_split">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">get_split</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">DataSplit</span><span class="p">:</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">splits</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Split &#39;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">&#39; not found. Available: </span><span class="si">{</span><span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">splits</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
Expand All @@ -326,7 +316,7 @@ <h1>Source code for pyhazards.datasets.base</h1><div class="highlight"><pre>


<div class="viewcode-block" id="Transform">
<a class="viewcode-back" href="../../../api/pyhazards.datasets.html#pyhazards.Transform">[docs]</a>
<a class="viewcode-back" href="../../../api/pyhazards.datasets.html#pyhazards.datasets.base.Transform">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">Transform</span><span class="p">(</span><span class="n">Protocol</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Callable data transform.&quot;&quot;&quot;</span>

Expand All @@ -336,7 +326,7 @@ <h1>Source code for pyhazards.datasets.base</h1><div class="highlight"><pre>


<div class="viewcode-block" id="Dataset">
<a class="viewcode-back" href="../../../api/pyhazards.datasets.html#pyhazards.Dataset">[docs]</a>
<a class="viewcode-back" href="../../../api/pyhazards.datasets.html#pyhazards.datasets.base.Dataset">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">Dataset</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Base class for hazard datasets.</span>
Expand All @@ -349,7 +339,7 @@ <h1>Source code for pyhazards.datasets.base</h1><div class="highlight"><pre>
<span class="bp">self</span><span class="o">.</span><span class="n">cache_dir</span> <span class="o">=</span> <span class="n">cache_dir</span>

<div class="viewcode-block" id="Dataset.load">
<a class="viewcode-back" href="../../../api/pyhazards.datasets.html#pyhazards.Dataset.load">[docs]</a>
<a class="viewcode-back" href="../../../api/pyhazards.datasets.html#pyhazards.datasets.base.Dataset.load">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">load</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">split</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">transforms</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">List</span><span class="p">[</span><span class="n">Transform</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">DataBundle</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Return a DataBundle. Optionally return a specific split if provided.</span>
Expand All @@ -369,7 +359,7 @@ <h1>Source code for pyhazards.datasets.base</h1><div class="highlight"><pre>


<div class="viewcode-block" id="Dataset._load">
<a class="viewcode-back" href="../../../api/pyhazards.datasets.html#pyhazards.Dataset._load">[docs]</a>
<a class="viewcode-back" href="../../../api/pyhazards.datasets.html#pyhazards.datasets.base.Dataset._load">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">_load</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">DataBundle</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s2">&quot;Subclasses must implement _load() to return a DataBundle.&quot;</span><span class="p">)</span></div>
</div>
Expand Down
12 changes: 1 addition & 11 deletions docs/_modules/pyhazards/datasets/graph.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,17 +206,7 @@
</ul>
<p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
<ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../pyhazards_datasets.html">Datasets</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Datasets</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../../../datasets/merra2.html">MERRA-2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../datasets/era5.html">ERA5</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../datasets/noaa_flood.html">NOAA Flood Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../datasets/firms.html">FIRMS</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../datasets/mtbs.html">MTBS</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../datasets/landfire.html">LANDFIRE</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../datasets/wfigs.html">WFIGS</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../datasets/goesr.html">GOES-R</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../../pyhazards_datasets.html">Datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../pyhazards_models.html">Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../pyhazards_engine.html">Engine</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../pyhazards_metrics.html">Metrics</a></li>
Expand Down
18 changes: 4 additions & 14 deletions docs/_modules/pyhazards/datasets/registry.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,17 +206,7 @@
</ul>
<p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
<ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../pyhazards_datasets.html">Datasets</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Datasets</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../../../datasets/merra2.html">MERRA-2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../datasets/era5.html">ERA5</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../datasets/noaa_flood.html">NOAA Flood Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../datasets/firms.html">FIRMS</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../datasets/mtbs.html">MTBS</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../datasets/landfire.html">LANDFIRE</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../datasets/wfigs.html">WFIGS</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../datasets/goesr.html">GOES-R</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../../pyhazards_datasets.html">Datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../pyhazards_models.html">Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../pyhazards_engine.html">Engine</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../pyhazards_metrics.html">Metrics</a></li>
Expand Down Expand Up @@ -271,7 +261,7 @@ <h1>Source code for pyhazards.datasets.registry</h1><div class="highlight"><pre>


<div class="viewcode-block" id="register_dataset">
<a class="viewcode-back" href="../../../api/pyhazards.datasets.html#pyhazards.register_dataset">[docs]</a>
<a class="viewcode-back" href="../../../api/pyhazards.datasets.html#pyhazards.datasets.registry.register_dataset">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">register_dataset</span><span class="p">(</span><span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">builder</span><span class="p">:</span> <span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">Dataset</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">_DATASET_REGISTRY</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Dataset &#39;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">&#39; already registered.&quot;</span><span class="p">)</span>
Expand All @@ -280,14 +270,14 @@ <h1>Source code for pyhazards.datasets.registry</h1><div class="highlight"><pre>


<div class="viewcode-block" id="available_datasets">
<a class="viewcode-back" href="../../../api/pyhazards.datasets.html#pyhazards.available_datasets">[docs]</a>
<a class="viewcode-back" href="../../../api/pyhazards.datasets.html#pyhazards.datasets.registry.available_datasets">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">available_datasets</span><span class="p">():</span>
<span class="k">return</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">_DATASET_REGISTRY</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span></div>



<div class="viewcode-block" id="load_dataset">
<a class="viewcode-back" href="../../../api/pyhazards.datasets.html#pyhazards.load_dataset">[docs]</a>
<a class="viewcode-back" href="../../../api/pyhazards.datasets.html#pyhazards.datasets.registry.load_dataset">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">load_dataset</span><span class="p">(</span><span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Dataset</span><span class="p">:</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">_DATASET_REGISTRY</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Dataset &#39;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">&#39; is not registered. Known: </span><span class="si">{</span><span class="n">available_datasets</span><span class="p">()</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
Expand Down
12 changes: 1 addition & 11 deletions docs/api/modules.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,17 +207,7 @@
</ul>
<p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
<ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="../pyhazards_datasets.html">Datasets</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Datasets</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../datasets/merra2.html">MERRA-2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../datasets/era5.html">ERA5</a></li>
<li class="toctree-l2"><a class="reference internal" href="../datasets/noaa_flood.html">NOAA Flood Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="../datasets/firms.html">FIRMS</a></li>
<li class="toctree-l2"><a class="reference internal" href="../datasets/mtbs.html">MTBS</a></li>
<li class="toctree-l2"><a class="reference internal" href="../datasets/landfire.html">LANDFIRE</a></li>
<li class="toctree-l2"><a class="reference internal" href="../datasets/wfigs.html">WFIGS</a></li>
<li class="toctree-l2"><a class="reference internal" href="../datasets/goesr.html">GOES-R</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../pyhazards_datasets.html">Datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../pyhazards_models.html">Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../pyhazards_engine.html">Engine</a></li>
<li class="toctree-l1"><a class="reference internal" href="../pyhazards_metrics.html">Metrics</a></li>
Expand Down
Loading