Skip to content

improve the site #14

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
JeIlyfish merged 1 commit into from
Jan 22, 2026
Merged

improve the site #14

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
Binary file modified docs/.doctrees/api/pyhazards.datasets.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/.doctrees/environment.pickle
View file
Open in desktop
Binary file not shown.
Binary file modified docs/.doctrees/pyhazards_datasets.doctree
View file
Open in desktop
Binary file not shown.
13 changes: 3 additions & 10 deletions docs/_sources/pyhazards_datasets.rst.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Datasets
- ECMWF ERA5 reanalysis served via the `Copernicus CDS <https://cds.climate.copernicus.eu/datasets/reanalysis-era5-single-levels?tab=overview>`_, providing hourly single-/pressure-level variables for benchmarks and hazard covariates; see `Hersbach et al. (2020) <https://rmets.onlinelibrary.wiley.com/doi/10.1002/qj.3803>`_.

* - :doc:`noaa_flood <datasets/noaa_flood>`
- Flood-related event reports from the `NOAA Storm Events Database <https://www.ncei.noaa.gov/products/storm-events-database>_` (time, location, impacts), commonly used for event-level labeling and impact analysis; see `NCEI record <https://www.ncei.noaa.gov/access/metadata/landing-page/bin/iso?id=gov.noaa.ncdc:C00648>`_(C00648).
- Flood-related event reports from the `NOAA Storm Events Database <https://www.ncei.noaa.gov/products/storm-events-database>`_ (time, location, impacts), commonly used for event-level labeling and impact analysis; see `NCEI record <https://www.ncei.noaa.gov/access/metadata/landing-page/bin/iso?id=gov.noaa.ncdc:C00648>`_(C00648).

* - :doc:`firms <datasets/firms>`
- Near-real-time active fire detections from `NASA FIRMS <https://firms.modaps.eosdis.nasa.gov/>`_ (MODIS/VIIRS), used for operational monitoring and as wildfire occurrence labels; see `Schroeder et al. (2014) <https://doi.org/10.1016/j.rse.2013.08.008>`_.
Expand All @@ -47,17 +47,10 @@ quickly explore dataset structure and contents through a unified API.
The example below demonstrates how to inspect a daily MERRA-2 file using
the PyHazards dataset interface.

.. code-block:: python

import pyhazards
.. code-block:: bash

dataset = pyhazards.datasets.MERRA2(
root="/path/to/merra2",
start_date="2024-01-01",
end_date="2024-01-31",
)
python -m pyhazards.datasets.inspection --root /path/to/Prithvi-WxC/data/merra-2 --day 2024-01-01

dataset.inspect(day="2024-01-01")

Core classes
------------
Expand Down
186 changes: 6 additions & 180 deletions docs/_static/pygments.css
View file
Open in desktop

Large diffs are not rendered by default.

263 changes: 10 additions & 253 deletions docs/api/pyhazards.datasets.html
View file
Open in desktop

Large diffs are not rendered by default.

59 changes: 4 additions & 55 deletions docs/api/pyhazards.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 Expand Up @@ -325,50 +315,9 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
<li class="toctree-l3"><a class="reference internal" href="pyhazards.datasets.html#pyhazards.datasets.registry.register_dataset"><code class="docutils literal notranslate"><span class="pre">register_dataset()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pyhazards.datasets.html#module-pyhazards.datasets.transforms">pyhazards.datasets.transforms package</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyhazards.datasets.html#module-pyhazards.datasets.hazards">pyhazards.datasets.hazards package</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyhazards.datasets.html#module-pyhazards.datasets">Module contents</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pyhazards.datasets.html#pyhazards.datasets.DataBundle"><code class="docutils literal notranslate"><span class="pre">DataBundle</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="pyhazards.datasets.html#pyhazards.datasets.DataBundle.feature_spec"><code class="docutils literal notranslate"><span class="pre">DataBundle.feature_spec</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pyhazards.datasets.html#pyhazards.datasets.DataBundle.get_split"><code class="docutils literal notranslate"><span class="pre">DataBundle.get_split()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pyhazards.datasets.html#pyhazards.datasets.DataBundle.label_spec"><code class="docutils literal notranslate"><span class="pre">DataBundle.label_spec</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pyhazards.datasets.html#pyhazards.datasets.DataBundle.metadata"><code class="docutils literal notranslate"><span class="pre">DataBundle.metadata</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pyhazards.datasets.html#pyhazards.datasets.DataBundle.splits"><code class="docutils literal notranslate"><span class="pre">DataBundle.splits</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pyhazards.datasets.html#pyhazards.datasets.DataSplit"><code class="docutils literal notranslate"><span class="pre">DataSplit</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="pyhazards.datasets.html#pyhazards.datasets.DataSplit.inputs"><code class="docutils literal notranslate"><span class="pre">DataSplit.inputs</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pyhazards.datasets.html#pyhazards.datasets.DataSplit.metadata"><code class="docutils literal notranslate"><span class="pre">DataSplit.metadata</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pyhazards.datasets.html#pyhazards.datasets.DataSplit.targets"><code class="docutils literal notranslate"><span class="pre">DataSplit.targets</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pyhazards.datasets.html#pyhazards.datasets.Dataset"><code class="docutils literal notranslate"><span class="pre">Dataset</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="pyhazards.datasets.html#pyhazards.datasets.Dataset._load"><code class="docutils literal notranslate"><span class="pre">Dataset._load()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pyhazards.datasets.html#pyhazards.datasets.Dataset.load"><code class="docutils literal notranslate"><span class="pre">Dataset.load()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pyhazards.datasets.html#pyhazards.datasets.Dataset.name"><code class="docutils literal notranslate"><span class="pre">Dataset.name</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pyhazards.datasets.html#pyhazards.datasets.FeatureSpec"><code class="docutils literal notranslate"><span class="pre">FeatureSpec</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="pyhazards.datasets.html#pyhazards.datasets.FeatureSpec.channels"><code class="docutils literal notranslate"><span class="pre">FeatureSpec.channels</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pyhazards.datasets.html#pyhazards.datasets.FeatureSpec.description"><code class="docutils literal notranslate"><span class="pre">FeatureSpec.description</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pyhazards.datasets.html#pyhazards.datasets.FeatureSpec.extra"><code class="docutils literal notranslate"><span class="pre">FeatureSpec.extra</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pyhazards.datasets.html#pyhazards.datasets.FeatureSpec.input_dim"><code class="docutils literal notranslate"><span class="pre">FeatureSpec.input_dim</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pyhazards.datasets.html#pyhazards.datasets.GraphTemporalDataset"><code class="docutils literal notranslate"><span class="pre">GraphTemporalDataset</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pyhazards.datasets.html#pyhazards.datasets.LabelSpec"><code class="docutils literal notranslate"><span class="pre">LabelSpec</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="pyhazards.datasets.html#pyhazards.datasets.LabelSpec.description"><code class="docutils literal notranslate"><span class="pre">LabelSpec.description</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pyhazards.datasets.html#pyhazards.datasets.LabelSpec.extra"><code class="docutils literal notranslate"><span class="pre">LabelSpec.extra</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pyhazards.datasets.html#pyhazards.datasets.LabelSpec.num_targets"><code class="docutils literal notranslate"><span class="pre">LabelSpec.num_targets</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="pyhazards.datasets.html#pyhazards.datasets.LabelSpec.task_type"><code class="docutils literal notranslate"><span class="pre">LabelSpec.task_type</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pyhazards.datasets.html#pyhazards.datasets.available_datasets"><code class="docutils literal notranslate"><span class="pre">available_datasets()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pyhazards.datasets.html#pyhazards.datasets.graph_collate"><code class="docutils literal notranslate"><span class="pre">graph_collate()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pyhazards.datasets.html#pyhazards.datasets.load_dataset"><code class="docutils literal notranslate"><span class="pre">load_dataset()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="pyhazards.datasets.html#pyhazards.datasets.register_dataset"><code class="docutils literal notranslate"><span class="pre">register_dataset()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pyhazards.datasets.html#pyhazards-datasets-transforms-package">pyhazards.datasets.transforms package</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyhazards.datasets.html#pyhazards-datasets-hazards-package">pyhazards.datasets.hazards package</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyhazards.datasets.html#module-contents">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pyhazards.models.html">pyhazards.models package</a><ul>
Expand Down
Loading
Loading