Skip to content

Commit

Permalink
deploy: af256ca
Browse files Browse the repository at this point in the history
  • Loading branch information
@jerrylin96
jerrylin96 committed Aug 22, 2023
1 parent 0261be8 commit 0fc6f18
Show file tree
Hide file tree
Showing 57 changed files with 9,322 additions and 903 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: e55ff71d5e34c542c153cb9972ccded6
config: 7e2da3bb54b899b03b4b4974f7b4ab4b
tags: 645f666f9bcd5a90fca523b33c5a78b7
61 changes: 46 additions & 15 deletions CONTRIBUTING.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<title>Developer Guide for the website &#8212; ClimSim</title>
<title>Contributor Guidelines &#8212; ClimSim</title>



Expand Down Expand Up @@ -64,6 +64,7 @@
<script>DOCUMENTATION_OPTIONS.pagename = 'CONTRIBUTING';</script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="Water conservation example" href="demo_notebooks/water_conservation.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
</head>
Expand Down Expand Up @@ -98,8 +99,8 @@
class="form-control"
name="q"
id="search-input"
placeholder="Search..."
aria-label="Search..."
placeholder="Search this book..."
aria-label="Search this book..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
Expand Down Expand Up @@ -129,7 +130,7 @@
<div class="sidebar-primary-item">


<a class="navbar-brand logo" href="intro.html">
<a class="navbar-brand logo" href="README.html">



Expand All @@ -140,13 +141,28 @@
</a></div>
<div class="sidebar-primary-item"><nav class="bd-links" id="bd-docs-nav" aria-label="Main">
<div class="bd-toc-item navbar-nav active">
<ul class="nav bd-sidenav">

<ul class="nav bd-sidenav bd-sidenav__home-link">
<li class="toctree-l1">
<a class="reference internal" href="README.html">
ClimSim: An open large-scale dataset for training high-resolution physics emulators in hybrid multi-scale climate simulators
</a>
</li>
</ul>
<ul class="current nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="dataset.html">Dataset Information</a></li>
<li class="toctree-l1"><a class="reference internal" href="evaluation.html">Model evaluation</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation &amp; setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="models.html">Baseline Models</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="evaluating.html">Evaluation</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="evaluation/main_figure_generation.html">Evaluation metrics</a></li>
<li class="toctree-l2"><a class="reference internal" href="evaluation/plot_R2_analysis.html">Prediction skill of temperature and specific humidity tendencies</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="demo_notebooks/mlp_example.html">MLP example</a></li>
<li class="toctree-l1"><a class="reference internal" href="demo_notebooks/cnn_example.html">CNN example</a></li>
<li class="toctree-l1"><a class="reference internal" href="demo_notebooks/water_conservation.html">Water conservation example</a></li>
<li class="toctree-l1 current active"><a class="current reference internal" href="#">Contributor Guidelines</a></li>
</ul>

</div>
Expand Down Expand Up @@ -283,7 +299,7 @@


<div id="jb-print-docs-body" class="onlyprint">
<h1>Developer Guide for the website</h1>
<h1>Contributor Guidelines</h1>
<!-- Table of contents -->
<div id="print-main-content">
<div id="jb-print-toc">
Expand All @@ -293,7 +309,8 @@ <h2> Contents </h2>
</div>
<nav aria-label="Page">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#jupter-book-based-website">Jupter Book based website</a><ul class="nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#feedback-and-future-development">Feedback and future development</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#developer-guide-for-the-website">Developer Guide for the website</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#how-to-build-the-website-locally">How to build the website locally</a></li>
</ul>
</li>
Expand All @@ -308,16 +325,20 @@ <h2> Contents </h2>
<div id="searchbox"></div>
<article class="bd-article" role="main">

<section class="tex2jax_ignore mathjax_ignore" id="developer-guide-for-the-website">
<h1>Developer Guide for the website<a class="headerlink" href="#developer-guide-for-the-website" title="Permalink to this heading">#</a></h1>
<section id="jupter-book-based-website">
<h2>Jupter Book based website<a class="headerlink" href="#jupter-book-based-website" title="Permalink to this heading">#</a></h2>
<p>Our <a class="reference external" href="https://leap-stc.github.io/ClimSim/">website</a> is built with <a class="reference external" href="https://jupyterbook.org/en/stable/intro.html">Jupyter Book</a></p>
<section class="tex2jax_ignore mathjax_ignore" id="contributor-guidelines">
<h1>Contributor Guidelines<a class="headerlink" href="#contributor-guidelines" title="Permalink to this heading">#</a></h1>
<section id="feedback-and-future-development">
<h2>Feedback and future development<a class="headerlink" href="#feedback-and-future-development" title="Permalink to this heading">#</a></h2>
<p>Additional issues from community researchers wishing to build off ClimSim or make use of our tools are welcome and can be raised using the GitHub issues page (preferred) or by directly emailing ClimSim maintainers.</p>
</section>
<section id="developer-guide-for-the-website">
<h2>Developer Guide for the website<a class="headerlink" href="#developer-guide-for-the-website" title="Permalink to this heading">#</a></h2>
<p>Our <a class="reference external" href="https://leap-stc.github.io/ClimSim/">website</a> is built with <a class="reference external" href="https://jupyterbook.org/en/stable/intro.html">Jupyter Book</a>.</p>
<section id="how-to-build-the-website-locally">
<h3>How to build the website locally<a class="headerlink" href="#how-to-build-the-website-locally" title="Permalink to this heading">#</a></h3>
<p>To mimic what <a class="reference external" href="https://github.com/leap-stc/ClimSim/blob/main/.github/workflows/publish-website.yml">GitHub Actions</a> does on GitHub, first copy the README and demo notebooks to the website directory.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>website
cp<span class="w"> </span>-r<span class="w"> </span>../demo_notebooks<span class="w"> </span>.
cp<span class="w"> </span>-r<span class="w"> </span>../README.md<span class="w"> </span>../figures<span class="w"> </span>../demo_notebooks<span class="w"> </span>../evaluation<span class="w"> </span>.
</pre></div>
</div>
<p>Create a local conda environment</p>
Expand Down Expand Up @@ -368,6 +389,15 @@ <h3>How to build the website locally<a class="headerlink" href="#how-to-build-th

<div class="footer-article-item"><!-- Previous / next buttons -->
<div class="prev-next-area">
<a class="left-prev"
href="demo_notebooks/water_conservation.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">Water conservation example</p>
</div>
</a>
</div></div>

</div>
Expand All @@ -386,7 +416,8 @@ <h3>How to build the website locally<a class="headerlink" href="#how-to-build-th
</div>
<nav class="bd-toc-nav page-toc">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#jupter-book-based-website">Jupter Book based website</a><ul class="nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#feedback-and-future-development">Feedback and future development</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#developer-guide-for-the-website">Developer Guide for the website</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#how-to-build-the-website-locally">How to build the website locally</a></li>
</ul>
</li>
Expand Down
Loading

0 comments on commit 0fc6f18

Please sign in to comment.