diff --git a/docs/build/doctrees/api.doctree b/docs/build/doctrees/api.doctree index 92bfea9e295af836b3a193825a335649d80f28c0..18726d2738a791ae2eef937c1fd8187cbfdc3b1c 100644 Binary files a/docs/build/doctrees/api.doctree and b/docs/build/doctrees/api.doctree differ diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle index 60b708c14077808f6c44cf17c15728c60fef268e..f89033911cc01499ecd3ba2d404be709dd97318b 100644 Binary files a/docs/build/doctrees/environment.pickle and b/docs/build/doctrees/environment.pickle differ diff --git a/docs/build/doctrees/example.doctree b/docs/build/doctrees/example.doctree index a84b0000e86941501b70ee8db6eb9ea7293c11e2..281e3603546b98b3f58602534f4c392aaa0b0306 100644 Binary files a/docs/build/doctrees/example.doctree and b/docs/build/doctrees/example.doctree differ diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree index ed3697af4211f710d1a4399075fa4cf3d35e5272..2bf2672ee88514435c26768885baec1e08c080b6 100644 Binary files a/docs/build/doctrees/index.doctree and b/docs/build/doctrees/index.doctree differ diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo index 839d3a9830a8f2838063bffa0c2f725e7ac5d85a..daf446ffd30688f98b194270878d724fc96817b1 100644 --- a/docs/build/html/.buildinfo +++ b/docs/build/html/.buildinfo @@ -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: 512dbb367b2d1501c30ac13c1b597739 +config: 99e195874bd4b203adb5461dc893eb82 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/build/html/_sources/example.rst.txt b/docs/build/html/_sources/example.rst.txt index 79d4afc15f5cadfaa135380a5df2a7292cf63df2..ee61ceefc852d1a28f33193e0fbe7da2f310930d 100644 --- a/docs/build/html/_sources/example.rst.txt +++ b/docs/build/html/_sources/example.rst.txt @@ -1,6 +1,6 @@ +Workflow +======== - -## Workflow #### Configure your experiment Define simulation specific variables in [`config/cfg.py`](https://github.com/lkugler/DART-WRF/blob/master/config/cfg.py). Define paths for python, ncks, etc. in [`config/clusters.py`](https://github.com/lkugler/DART-WRF/blob/master/config/clusters.py). diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt index e043d507d16e74f95ddb3bca3fdf7d549944dd82..3b23e27aadb68ffba9a22833a3fc5cd92f1deb04 100644 --- a/docs/build/html/_sources/index.rst.txt +++ b/docs/build/html/_sources/index.rst.txt @@ -3,18 +3,6 @@ Welcome to the DART-WRF documentation! DART-WRF is a Python package to run an Ensemble Data Assimilation system with the software packages DART and WRF. -- Why should I use it? - - It's pythonic: see what it does at first glance, modular, flexible - - It handles dependencies using SLURM without '`sleep` loops in the bash script'. -Functions return a SLURM ID which can be used to trigger the start of another function (interface by [brentp/slurmpy](https://github.com/brentp/slurmpy)). - -- How does it work? - - There are two kinds of code/scripts: One that is run immediately and one that is run later on. - - The first one instructs the cluster (SLURM) to do the things you tell it - in the right order - using the right input. - - The latter kind of code actually does the things. Its code is not executed right away, but when there are resources assigned to you by SLURM. - -- Can I use it for real weather? - - Yes, but you need to [convert your observations into DART format.](https://docs.dart.ucar.edu) @@ -23,7 +11,6 @@ Contents .. toctree:: - usage api - docs/source/example + example diff --git a/docs/build/html/_static/pygments.css b/docs/build/html/_static/pygments.css index 9abe04ba552e93102be60b10311b288fbc57ab51..08bec689d3306e6c13d1973f61a01bee9a307e87 100644 --- a/docs/build/html/_static/pygments.css +++ b/docs/build/html/_static/pygments.css @@ -5,79 +5,70 @@ td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5 span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } .highlight .hll { background-color: #ffffcc } .highlight { background: #f8f8f8; } -.highlight .c { color: #8f5902; font-style: italic } /* Comment */ -.highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */ -.highlight .g { color: #000000 } /* Generic */ -.highlight .k { color: #004461; font-weight: bold } /* Keyword */ -.highlight .l { color: #000000 } /* Literal */ -.highlight .n { color: #000000 } /* Name */ -.highlight .o { color: #582800 } /* Operator */ -.highlight .x { color: #000000 } /* Other */ -.highlight .p { color: #000000; font-weight: bold } /* Punctuation */ -.highlight .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */ -.highlight .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */ -.highlight .cp { color: #8f5902 } /* Comment.Preproc */ -.highlight .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */ -.highlight .c1 { color: #8f5902; font-style: italic } /* Comment.Single */ -.highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */ -.highlight .gd { color: #a40000 } /* Generic.Deleted */ -.highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */ -.highlight .gr { color: #ef2929 } /* Generic.Error */ +.highlight .c { color: #3D7B7B; font-style: italic } /* Comment */ +.highlight .err { border: 1px solid #FF0000 } /* Error */ +.highlight .k { color: #008000; font-weight: bold } /* Keyword */ +.highlight .o { color: #666666 } /* Operator */ +.highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #9C6500 } /* Comment.Preproc */ +.highlight .cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */ +.highlight .gd { color: #A00000 } /* Generic.Deleted */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .gr { color: #E40000 } /* Generic.Error */ .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ -.highlight .gi { color: #00A000 } /* Generic.Inserted */ -.highlight .go { color: #888888 } /* Generic.Output */ -.highlight .gp { color: #745334 } /* Generic.Prompt */ -.highlight .gs { color: #000000; font-weight: bold } /* Generic.Strong */ +.highlight .gi { color: #008400 } /* Generic.Inserted */ +.highlight .go { color: #717171 } /* Generic.Output */ +.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ -.highlight .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */ -.highlight .kc { color: #004461; font-weight: bold } /* Keyword.Constant */ -.highlight .kd { color: #004461; font-weight: bold } /* Keyword.Declaration */ -.highlight .kn { color: #004461; font-weight: bold } /* Keyword.Namespace */ -.highlight .kp { color: #004461; font-weight: bold } /* Keyword.Pseudo */ -.highlight .kr { color: #004461; font-weight: bold } /* Keyword.Reserved */ -.highlight .kt { color: #004461; font-weight: bold } /* Keyword.Type */ -.highlight .ld { color: #000000 } /* Literal.Date */ -.highlight .m { color: #990000 } /* Literal.Number */ -.highlight .s { color: #4e9a06 } /* Literal.String */ -.highlight .na { color: #c4a000 } /* Name.Attribute */ -.highlight .nb { color: #004461 } /* Name.Builtin */ -.highlight .nc { color: #000000 } /* Name.Class */ -.highlight .no { color: #000000 } /* Name.Constant */ -.highlight .nd { color: #888888 } /* Name.Decorator */ -.highlight .ni { color: #ce5c00 } /* Name.Entity */ -.highlight .ne { color: #cc0000; font-weight: bold } /* Name.Exception */ -.highlight .nf { color: #000000 } /* Name.Function */ -.highlight .nl { color: #f57900 } /* Name.Label */ -.highlight .nn { color: #000000 } /* Name.Namespace */ -.highlight .nx { color: #000000 } /* Name.Other */ -.highlight .py { color: #000000 } /* Name.Property */ -.highlight .nt { color: #004461; font-weight: bold } /* Name.Tag */ -.highlight .nv { color: #000000 } /* Name.Variable */ -.highlight .ow { color: #004461; font-weight: bold } /* Operator.Word */ -.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */ -.highlight .w { color: #f8f8f8; text-decoration: underline } /* Text.Whitespace */ -.highlight .mb { color: #990000 } /* Literal.Number.Bin */ -.highlight .mf { color: #990000 } /* Literal.Number.Float */ -.highlight .mh { color: #990000 } /* Literal.Number.Hex */ -.highlight .mi { color: #990000 } /* Literal.Number.Integer */ -.highlight .mo { color: #990000 } /* Literal.Number.Oct */ -.highlight .sa { color: #4e9a06 } /* Literal.String.Affix */ -.highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */ -.highlight .sc { color: #4e9a06 } /* Literal.String.Char */ -.highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */ -.highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */ -.highlight .s2 { color: #4e9a06 } /* Literal.String.Double */ -.highlight .se { color: #4e9a06 } /* Literal.String.Escape */ -.highlight .sh { color: #4e9a06 } /* Literal.String.Heredoc */ -.highlight .si { color: #4e9a06 } /* Literal.String.Interpol */ -.highlight .sx { color: #4e9a06 } /* Literal.String.Other */ -.highlight .sr { color: #4e9a06 } /* Literal.String.Regex */ -.highlight .s1 { color: #4e9a06 } /* Literal.String.Single */ -.highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */ -.highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */ -.highlight .fm { color: #000000 } /* Name.Function.Magic */ -.highlight .vc { color: #000000 } /* Name.Variable.Class */ -.highlight .vg { color: #000000 } /* Name.Variable.Global */ -.highlight .vi { color: #000000 } /* Name.Variable.Instance */ -.highlight .vm { color: #000000 } /* Name.Variable.Magic */ -.highlight .il { color: #990000 } /* Literal.Number.Integer.Long */ \ No newline at end of file +.highlight .gt { color: #0044DD } /* Generic.Traceback */ +.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #008000 } /* Keyword.Pseudo */ +.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #B00040 } /* Keyword.Type */ +.highlight .m { color: #666666 } /* Literal.Number */ +.highlight .s { color: #BA2121 } /* Literal.String */ +.highlight .na { color: #687822 } /* Name.Attribute */ +.highlight .nb { color: #008000 } /* Name.Builtin */ +.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */ +.highlight .no { color: #880000 } /* Name.Constant */ +.highlight .nd { color: #AA22FF } /* Name.Decorator */ +.highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */ +.highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #0000FF } /* Name.Function */ +.highlight .nl { color: #767600 } /* Name.Label */ +.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ +.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #19177C } /* Name.Variable */ +.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ +.highlight .w { color: #bbbbbb } /* Text.Whitespace */ +.highlight .mb { color: #666666 } /* Literal.Number.Bin */ +.highlight .mf { color: #666666 } /* Literal.Number.Float */ +.highlight .mh { color: #666666 } /* Literal.Number.Hex */ +.highlight .mi { color: #666666 } /* Literal.Number.Integer */ +.highlight .mo { color: #666666 } /* Literal.Number.Oct */ +.highlight .sa { color: #BA2121 } /* Literal.String.Affix */ +.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */ +.highlight .sc { color: #BA2121 } /* Literal.String.Char */ +.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */ +.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #BA2121 } /* Literal.String.Double */ +.highlight .se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */ +.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */ +.highlight .si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */ +.highlight .sx { color: #008000 } /* Literal.String.Other */ +.highlight .sr { color: #A45A77 } /* Literal.String.Regex */ +.highlight .s1 { color: #BA2121 } /* Literal.String.Single */ +.highlight .ss { color: #19177C } /* Literal.String.Symbol */ +.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #0000FF } /* Name.Function.Magic */ +.highlight .vc { color: #19177C } /* Name.Variable.Class */ +.highlight .vg { color: #19177C } /* Name.Variable.Global */ +.highlight .vi { color: #19177C } /* Name.Variable.Instance */ +.highlight .vm { color: #19177C } /* Name.Variable.Magic */ +.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/docs/build/html/api.html b/docs/build/html/api.html index 70fc682d908edde44e739035c7a7aaa6843036ce..2e25becbef3b575856aa5435712b212681133008 100644 --- a/docs/build/html/api.html +++ b/docs/build/html/api.html @@ -1,97 +1,111 @@ - <!DOCTYPE html> - -<html lang="en"> - <head> - <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> - - <title><no title> — DART-WRF 2023.2.17 documentation</title> - <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> - <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> - <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> - <script src="_static/doctools.js"></script> - <script src="_static/sphinx_highlight.js"></script> +<html class="writer-html5" lang="en" > +<head> + <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title><no title> — DART-WRF 2023.2.17 documentation</title> + <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> + <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> + <!--[if lt IE 9]> + <script src="_static/js/html5shiv.min.js"></script> + <![endif]--> + + <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script> + <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> + <script src="_static/doctools.js"></script> + <script src="_static/sphinx_highlight.js"></script> + <script src="_static/js/theme.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> - - <link rel="stylesheet" href="_static/custom.css" type="text/css" /> - - - <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> + <link rel="next" title="dartwrf" href="generated/dartwrf.html" /> + <link rel="prev" title="Welcome to the DART-WRF documentation!" href="index.html" /> +</head> - </head><body> - +<body class="wy-body-for-nav"> + <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > - <div class="document"> - <div class="documentwrapper"> - <div class="bodywrapper"> - - <div class="body" role="main"> - - - - </div> + <a href="index.html" class="icon icon-home"> + DART-WRF + </a> +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> + <ul> +<li class="toctree-l1"><a class="reference internal" href="generated/dartwrf.html">dartwrf</a></li> +</ul> + </div> </div> - <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> - <div class="sphinxsidebarwrapper"> -<h1 class="logo"><a href="index2.html">DART-WRF</a></h1> - - - - - - - - -<h3>Navigation</h3> - -<div class="relations"> -<h3>Related Topics</h3> -<ul> - <li><a href="index2.html">Documentation overview</a><ul> - </ul></li> -</ul> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="index.html">DART-WRF</a> + </nav> + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="Page navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> + <li class="breadcrumb-item active"><no title></li> + <li class="wy-breadcrumbs-aside"> + <a href="_sources/api.rst.txt" rel="nofollow"> View page source</a> + </li> + </ul> + <hr/> </div> -<div id="searchbox" style="display: none" role="search"> - <h3 id="searchlabel">Quick search</h3> - <div class="searchformwrapper"> - <form class="search" action="search.html" method="get"> - <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/> - <input type="submit" value="Go" /> - </form> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <table class="autosummary longtable docutils align-default"> +<tbody> +<tr class="row-odd"><td><p><a class="reference internal" href="generated/dartwrf.html#module-dartwrf" title="dartwrf"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dartwrf</span></code></a></p></td> +<td><p></p></td> +</tr> +</tbody> +</table> + + + </div> + </div> + <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> + <a href="index.html" class="btn btn-neutral float-left" title="Welcome to the DART-WRF documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="generated/dartwrf.html" class="btn btn-neutral float-right" title="dartwrf" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> </div> -</div> -<script>document.getElementById('searchbox').style.display = "block"</script> - - - - + <hr/> + <div role="contentinfo"> + <p>© Copyright 2023, Lukas Kugler.</p> + </div> + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> </div> </div> - <div class="clearer"></div> - </div> - <div class="footer"> - ©2023, Lukas Kugler. - - | - Powered by <a href="http://sphinx-doc.org/">Sphinx 6.1.3</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> - - | - <a href="_sources/api.rst.txt" - rel="nofollow">Page source</a> - </div> - - - - - </body> + </section> + </div> + <script> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> </html> \ No newline at end of file diff --git a/docs/build/html/example.html b/docs/build/html/example.html index 1497caae0a274c73b3a501632cffd7615549c5cb..e1d61b95a097b68b38fef2f671442c51b1f03fcb 100644 --- a/docs/build/html/example.html +++ b/docs/build/html/example.html @@ -1,37 +1,77 @@ - <!DOCTYPE html> - -<html lang="en"> - <head> - <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> - - <title><no title> — DART-WRF 2023.2.17 documentation</title> - <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> - <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> - <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> - <script src="_static/doctools.js"></script> - <script src="_static/sphinx_highlight.js"></script> +<html class="writer-html5" lang="en" > +<head> + <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>Workflow — DART-WRF 2023.2.17 documentation</title> + <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> + <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> + <!--[if lt IE 9]> + <script src="_static/js/html5shiv.min.js"></script> + <![endif]--> + + <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script> + <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> + <script src="_static/doctools.js"></script> + <script src="_static/sphinx_highlight.js"></script> + <script src="_static/js/theme.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> - - <link rel="stylesheet" href="_static/custom.css" type="text/css" /> - - - <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> + <link rel="prev" title="dartwrf" href="generated/dartwrf.html" /> +</head> - </head><body> - +<body class="wy-body-for-nav"> + <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > - <div class="document"> - <div class="documentwrapper"> - <div class="bodywrapper"> + + <a href="index.html" class="icon icon-home"> + DART-WRF + </a> +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="generated/dartwrf.html">dartwrf</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">Workflow</a></li> +</ul> - <div class="body" role="main"> - - <p>## Workflow -#### Configure your experiment + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="index.html">DART-WRF</a> + </nav> + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="Page navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> + <li class="breadcrumb-item active">Workflow</li> + <li class="wy-breadcrumbs-aside"> + <a href="_sources/example.rst.txt" rel="nofollow"> View page source</a> + </li> + </ul> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <section id="workflow"> +<h1>Workflow<a class="headerlink" href="#workflow" title="Permalink to this heading"></a></h1> +<p>#### Configure your experiment Define simulation specific variables in [<cite>config/cfg.py</cite>](<a class="reference external" href="https://github.com/lkugler/DART-WRF/blob/master/config/cfg.py">https://github.com/lkugler/DART-WRF/blob/master/config/cfg.py</a>). Define paths for python, ncks, etc. in [<cite>config/clusters.py</cite>](<a class="reference external" href="https://github.com/lkugler/DART-WRF/blob/master/config/clusters.py">https://github.com/lkugler/DART-WRF/blob/master/config/clusters.py</a>). Dependencies are <cite>numpy, pandas, scipy, xarray, netCDF4</cite>. Install non-standard packages with <cite>pip install docopt slurmpy –user</cite>. @@ -125,68 +165,36 @@ clusterB = ClusterConfig() clusterB.name = ‘jet’ clusterB.userdir = ‘/home/pathB/myuser/’ <a href="#id23"><span class="problematic" id="id24">``</span></a><a href="#id25"><span class="problematic" id="id26">`</span></a></p> +</section> + </div> </div> - - </div> - </div> - <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> - <div class="sphinxsidebarwrapper"> -<h1 class="logo"><a href="index2.html">DART-WRF</a></h1> - - - - - - - - -<h3>Navigation</h3> - -<div class="relations"> -<h3>Related Topics</h3> -<ul> - <li><a href="index2.html">Documentation overview</a><ul> - </ul></li> -</ul> -</div> -<div id="searchbox" style="display: none" role="search"> - <h3 id="searchlabel">Quick search</h3> - <div class="searchformwrapper"> - <form class="search" action="search.html" method="get"> - <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/> - <input type="submit" value="Go" /> - </form> + <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> + <a href="generated/dartwrf.html" class="btn btn-neutral float-left" title="dartwrf" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div> -</div> -<script>document.getElementById('searchbox').style.display = "block"</script> - - - - + <hr/> + <div role="contentinfo"> + <p>© Copyright 2023, Lukas Kugler.</p> + </div> + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> </div> </div> - <div class="clearer"></div> - </div> - <div class="footer"> - ©2023, Lukas Kugler. - - | - Powered by <a href="http://sphinx-doc.org/">Sphinx 6.1.3</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> - - | - <a href="_sources/example.rst.txt" - rel="nofollow">Page source</a> - </div> - - - - - </body> + </section> + </div> + <script> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> </html> \ No newline at end of file diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html index 814f2b0555887a6b4a2072ff232cdd792f3fd76d..42493693a4ed5956d7d48d7797661b5bdc2346ac 100644 --- a/docs/build/html/genindex.html +++ b/docs/build/html/genindex.html @@ -1,99 +1,132 @@ - <!DOCTYPE html> - -<html lang="en"> - <head> - <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Index — DART-WRF 2023.2.17 documentation</title> - <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> - <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> - <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> - <script src="_static/doctools.js"></script> - <script src="_static/sphinx_highlight.js"></script> - <link rel="index" title="Index" href="#" /> - <link rel="search" title="Search" href="search.html" /> - - <link rel="stylesheet" href="_static/custom.css" type="text/css" /> - +<html class="writer-html5" lang="en" > +<head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>Index — DART-WRF 2023.2.17 documentation</title> + <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> + <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> + <!--[if lt IE 9]> + <script src="_static/js/html5shiv.min.js"></script> + <![endif]--> - <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> + <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script> + <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> + <script src="_static/doctools.js"></script> + <script src="_static/sphinx_highlight.js"></script> + <script src="_static/js/theme.js"></script> + <link rel="index" title="Index" href="#" /> + <link rel="search" title="Search" href="search.html" /> +</head> - </head><body> - +<body class="wy-body-for-nav"> + <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > - <div class="document"> - <div class="documentwrapper"> - <div class="bodywrapper"> + + <a href="index.html" class="icon icon-home"> + DART-WRF + </a> +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> + <ul> +<li class="toctree-l1"><a class="reference internal" href="generated/dartwrf.html">dartwrf</a></li> +<li class="toctree-l1"><a class="reference internal" href="example.html">Workflow</a></li> +</ul> - <div class="body" role="main"> - + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="index.html">DART-WRF</a> + </nav> + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="Page navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> + <li class="breadcrumb-item active">Index</li> + <li class="wy-breadcrumbs-aside"> + </li> + </ul> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + <h1 id="index">Index</h1> <div class="genindex-jumpbox"> + <a href="#D"><strong>D</strong></a> + | <a href="#M"><strong>M</strong></a> </div> - - +<h2 id="D">D</h2> +<table style="width: 100%" class="indextable genindextable"><tr> + <td style="width: 33%; vertical-align: top;"><ul> + <li> + dartwrf + + <ul> + <li><a href="generated/dartwrf.html#module-dartwrf">module</a> +</li> + </ul></li> + </ul></td> +</tr></table> + +<h2 id="M">M</h2> +<table style="width: 100%" class="indextable genindextable"><tr> + <td style="width: 33%; vertical-align: top;"><ul> + <li> + module + + <ul> + <li><a href="generated/dartwrf.html#module-dartwrf">dartwrf</a> +</li> + </ul></li> + </ul></td> +</tr></table> + + + + </div> </div> - - </div> - </div> - <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> - <div class="sphinxsidebarwrapper"> -<h1 class="logo"><a href="index2.html">DART-WRF</a></h1> - - - - - - - - -<h3>Navigation</h3> - -<div class="relations"> -<h3>Related Topics</h3> -<ul> - <li><a href="index2.html">Documentation overview</a><ul> - </ul></li> -</ul> -</div> -<div id="searchbox" style="display: none" role="search"> - <h3 id="searchlabel">Quick search</h3> - <div class="searchformwrapper"> - <form class="search" action="search.html" method="get"> - <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/> - <input type="submit" value="Go" /> - </form> - </div> -</div> -<script>document.getElementById('searchbox').style.display = "block"</script> - - - - + <footer> + <hr/> + <div role="contentinfo"> + <p>© Copyright 2023, Lukas Kugler.</p> + </div> + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> </div> </div> - <div class="clearer"></div> - </div> - <div class="footer"> - ©2023, Lukas Kugler. - - | - Powered by <a href="http://sphinx-doc.org/">Sphinx 6.1.3</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> - - </div> - - - - - </body> + </section> + </div> + <script> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> </html> \ No newline at end of file diff --git a/docs/build/html/index.html b/docs/build/html/index.html index 16f27f10760b9c65174491d974fc9e36ca6d4e13..741af69e45e7a35b9e2be41247449fc57b9b8af8 100644 --- a/docs/build/html/index.html +++ b/docs/build/html/index.html @@ -1,120 +1,116 @@ - <!DOCTYPE html> - -<html lang="en"> - <head> - <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> - - <title>Welcome to the DART-WRF documentation! — DART-WRF 2023.2.17 documentation</title> - <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> - <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> - <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> - <script src="_static/doctools.js"></script> - <script src="_static/sphinx_highlight.js"></script> +<html class="writer-html5" lang="en" > +<head> + <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>Welcome to the DART-WRF documentation! — DART-WRF 2023.2.17 documentation</title> + <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> + <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> + <!--[if lt IE 9]> + <script src="_static/js/html5shiv.min.js"></script> + <![endif]--> + + <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script> + <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> + <script src="_static/doctools.js"></script> + <script src="_static/sphinx_highlight.js"></script> + <script src="_static/js/theme.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> - - <link rel="stylesheet" href="_static/custom.css" type="text/css" /> - - - <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> + <link rel="next" title="<no title>" href="api.html" /> +</head> - </head><body> - +<body class="wy-body-for-nav"> + <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > - <div class="document"> - <div class="documentwrapper"> - <div class="bodywrapper"> + + <a href="#" class="icon icon-home"> + DART-WRF + </a> +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> + <ul> +<li class="toctree-l1"><a class="reference internal" href="generated/dartwrf.html">dartwrf</a></li> +<li class="toctree-l1"><a class="reference internal" href="example.html">Workflow</a></li> +</ul> - <div class="body" role="main"> - + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="#">DART-WRF</a> + </nav> + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="Page navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="#" class="icon icon-home" aria-label="Home"></a></li> + <li class="breadcrumb-item active">Welcome to the DART-WRF documentation!</li> + <li class="wy-breadcrumbs-aside"> + <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a> + </li> + </ul> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + <section id="welcome-to-the-dart-wrf-documentation"> -<h1>Welcome to the DART-WRF documentation!<a class="headerlink" href="#welcome-to-the-dart-wrf-documentation" title="Permalink to this heading">¶</a></h1> +<h1>Welcome to the DART-WRF documentation!<a class="headerlink" href="#welcome-to-the-dart-wrf-documentation" title="Permalink to this heading"></a></h1> <p>DART-WRF is a Python package to run an Ensemble Data Assimilation system with the software packages DART and WRF.</p> -<ul class="simple"> -<li><p>Why should I use it? -- It’s pythonic: see what it does at first glance, modular, flexible -- It handles dependencies using SLURM without ‘<cite>sleep</cite> loops in the bash script’.</p></li> -</ul> -<p>Functions return a SLURM ID which can be used to trigger the start of another function (interface by [brentp/slurmpy](<a class="reference external" href="https://github.com/brentp/slurmpy">https://github.com/brentp/slurmpy</a>)).</p> -<ul class="simple"> -<li><p>How does it work? -- There are two kinds of code/scripts: One that is run immediately and one that is run later on. -- The first one instructs the cluster (SLURM) to do the things you tell it - in the right order - using the right input. -- The latter kind of code actually does the things. Its code is not executed right away, but when there are resources assigned to you by SLURM.</p></li> -<li><p>Can I use it for real weather? -- Yes, but you need to [convert your observations into DART format.](<a class="reference external" href="https://docs.dart.ucar.edu">https://docs.dart.ucar.edu</a>)</p></li> -</ul> <section id="contents"> -<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading">¶</a></h2> +<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading"></a></h2> <div class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="generated/dartwrf.html">dartwrf</a></li> +<li class="toctree-l1"><a class="reference internal" href="example.html">Workflow</a></li> +</ul> </div> </section> </section> + </div> </div> - - </div> - </div> - <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> - <div class="sphinxsidebarwrapper"> -<h1 class="logo"><a href="index2.html">DART-WRF</a></h1> - - - - - - - - -<h3>Navigation</h3> - -<div class="relations"> -<h3>Related Topics</h3> -<ul> - <li><a href="index2.html">Documentation overview</a><ul> - </ul></li> -</ul> -</div> -<div id="searchbox" style="display: none" role="search"> - <h3 id="searchlabel">Quick search</h3> - <div class="searchformwrapper"> - <form class="search" action="search.html" method="get"> - <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/> - <input type="submit" value="Go" /> - </form> + <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> + <a href="api.html" class="btn btn-neutral float-right" title="<no title>" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> </div> -</div> -<script>document.getElementById('searchbox').style.display = "block"</script> - - - - + <hr/> + <div role="contentinfo"> + <p>© Copyright 2023, Lukas Kugler.</p> + </div> + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> </div> </div> - <div class="clearer"></div> - </div> - <div class="footer"> - ©2023, Lukas Kugler. - - | - Powered by <a href="http://sphinx-doc.org/">Sphinx 6.1.3</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> - - | - <a href="_sources/index.rst.txt" - rel="nofollow">Page source</a> - </div> - - - - - </body> + </section> + </div> + <script> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> </html> \ No newline at end of file diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv index 67e9294dd995a78edee1af5aab09545a18ab7c9e..c8d516c930bfdbaf37a0b7015513febd3ad2d996 100644 Binary files a/docs/build/html/objects.inv and b/docs/build/html/objects.inv differ diff --git a/docs/build/html/search.html b/docs/build/html/search.html index 075b53210fd7f8493b41c43341df5424d824740d..51336d1c30e10233f99d713a5918c0bb9c4720ef 100644 --- a/docs/build/html/search.html +++ b/docs/build/html/search.html @@ -1,118 +1,119 @@ - <!DOCTYPE html> - -<html lang="en"> - <head> - <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>Search — DART-WRF 2023.2.17 documentation</title> - <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> - <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> +<html class="writer-html5" lang="en" > +<head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>Search — DART-WRF 2023.2.17 documentation</title> + <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> + <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> - <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> - <script src="_static/doctools.js"></script> - <script src="_static/sphinx_highlight.js"></script> + <!--[if lt IE 9]> + <script src="_static/js/html5shiv.min.js"></script> + <![endif]--> + + <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script> + <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> + <script src="_static/doctools.js"></script> + <script src="_static/sphinx_highlight.js"></script> + <script src="_static/js/theme.js"></script> <script src="_static/searchtools.js"></script> <script src="_static/language_data.js"></script> <link rel="index" title="Index" href="genindex.html" /> - <link rel="search" title="Search" href="#" /> - <script src="searchindex.js" defer></script> - - - <link rel="stylesheet" href="_static/custom.css" type="text/css" /> - - - <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> + <link rel="search" title="Search" href="#" /> +</head> +<body class="wy-body-for-nav"> + <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > - </head><body> - - - <div class="document"> - <div class="documentwrapper"> - <div class="bodywrapper"> + + <a href="index.html" class="icon icon-home"> + DART-WRF + </a> +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="#" method="get"> + <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> + <ul> +<li class="toctree-l1"><a class="reference internal" href="generated/dartwrf.html">dartwrf</a></li> +<li class="toctree-l1"><a class="reference internal" href="example.html">Workflow</a></li> +</ul> - <div class="body" role="main"> - - <h1 id="search-documentation">Search</h1> - + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="index.html">DART-WRF</a> + </nav> + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="Page navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> + <li class="breadcrumb-item active">Search</li> + <li class="wy-breadcrumbs-aside"> + </li> + </ul> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + <noscript> - <div class="admonition warning"> - <p> - Please activate JavaScript to enable the search - functionality. - </p> + <div id="fallback" class="admonition warning"> + <p class="last"> + Please activate JavaScript to enable the search functionality. + </p> </div> </noscript> - - - <p> - Searching for multiple words only shows matches that contain - all words. - </p> - - - <form action="" method="get"> - <input type="text" name="q" aria-labelledby="search-documentation" value="" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/> - <input type="submit" value="search" /> - <span id="search-progress" style="padding-left: 10px"></span> - </form> - - + <div id="search-results"> </div> - + </div> </div> - - </div> - </div> - <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> - <div class="sphinxsidebarwrapper"> -<h1 class="logo"><a href="index2.html">DART-WRF</a></h1> - - - - - - - - -<h3>Navigation</h3> - -<div class="relations"> -<h3>Related Topics</h3> -<ul> - <li><a href="index2.html">Documentation overview</a><ul> - </ul></li> -</ul> -</div> - - - - + <footer> + <hr/> + <div role="contentinfo"> + <p>© Copyright 2023, Lukas Kugler.</p> + </div> + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> </div> </div> - <div class="clearer"></div> - </div> - <div class="footer"> - ©2023, Lukas Kugler. - - | - Powered by <a href="http://sphinx-doc.org/">Sphinx 6.1.3</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> - - </div> + </section> + </div> + <script> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + <script> + jQuery(function() { Search.loadIndex("searchindex.js"); }); + </script> + + <script id="searchindexloader"></script> + - - - </body> +</body> </html> \ No newline at end of file diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js index 6880cbd39db7deaad02713032ff71cdd311fce75..6ea2ae123d033ea6ebee33b3fe181969a2a7d268 100644 --- a/docs/build/html/searchindex.js +++ b/docs/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["api", "example", "index", "index2"], "filenames": ["api.rst", "example.rst", "index.rst", "index2.rst"], "titles": ["<no title>", "<no title>", "Welcome to the DART-WRF documentation!", "Welcome to DART-WRF\u2019s documentation!"], "terms": {"workflow": 1, "configur": 1, "your": [1, 2], "experi": 1, "defin": 1, "simul": 1, "specif": 1, "variabl": 1, "config": 1, "cfg": 1, "py": 1, "http": [1, 2], "github": [1, 2], "com": [1, 2], "lkugler": 1, "dart": 1, "wrf": 1, "blob": 1, "master": 1, "path": 1, "python": [1, 2], "nck": 1, "etc": 1, "cluster": [1, 2], "depend": [1, 2], "ar": [1, 2], "numpi": 1, "panda": 1, "scipi": 1, "xarrai": 1, "netcdf4": 1, "instal": 1, "non": 1, "standard": 1, "packag": [1, 2], "pip": 1, "docopt": 1, "slurmpi": [1, 2], "user": 1, "i": [1, 2], "us": [1, 2], "meta": 1, "routin": 1, "function": [1, 2], "like": 1, "run_en": 1, "which": [1, 2], "schedul": 1, "prepar": 1, "initi": 1, "condit": 1, "from": 1, "input_sound": 1, "1": 1, "start": [1, 2], "time": 1, "begin": 1, "dt": 1, "datetim": 1, "2008": 1, "7": 1, "30": 1, "6": 1, "2": 1, "need": [1, 2], "directori": 1, "certain": 1, "file": 1, "id": [1, 2], "prepare_wrfrundir": 1, "3": 1, "creat": 1, "3d": 1, "run_id": 1, "depends_on": 1, "run": [1, 2], "free": 1, "forecast": 1, "let": 1, "": [1, 2], "sai": 1, "you": [1, 2], "want": 1, "6z": 1, "prior": 1, "an": [1, 2], "assimil": [1, 2], "9z": 1, "Then": 1, "can": [1, 2], "abov": 1, "step": 1, "ensembl": [1, 2], "integr": 1, "here": 1, "end": 1, "until": 1, "input_is_restart": 1, "fals": 1, "output_restart_interv": 1, "total_second": 1, "60": 1, "where": 1, "object": 1, "To": 1, "observ": [1, 2], "thi": 1, "command": 1, "prior_init_tim": 1, "prior_valid_tim": 1, "prior_path_exp": 1, "updat": 1, "data": [1, 2], "In": 1, "order": [1, 2], "continu": 1, "after": 1, "posterior": 1, "increment": 1, "set": 1, "prepare_ic_from_prior": 1, "str": 1, "model": 1, "state": 1, "restart": 1, "update_ic_from_da": 1, "wrfrst": 1, "filter_restart": 1, "copi": 1, "so": 1, "en": 1, "timedelta_integr": 1, "restart_path": 1, "archivedir": 1, "strftime": 1, "y": 1, "m": 1, "d_": 1, "h": 1, "timedelta_btw_assim": 1, "timedelta": 1, "exampl": 1, "generate_fre": 1, "final": 1, "slurm": [1, 2], "submiss": 1, "submit": 1, "job": 1, "queue": 1, "itself": 1, "soon": 1, "resourc": [1, 2], "avail": 1, "most": 1, "onli": 1, "one": [1, 2], "node": 1, "done": 1, "arrai": 1, "across": 1, "e": 1, "g": 1, "10": 1, "squeue": 1, "u": 1, "whoami": 1, "sort": 1, "jobid": 1, "partit": 1, "name": 1, "st": 1, "nodelist": 1, "reason": 1, "1710274": 1, "mem_0384": 1, "prepwrfr": 1, "pd": 1, "0": 1, "00": 1, "prioriti": 1, "1710275": 1, "ic": 1, "1710276": 1, "assim": 1, "42": 1, "1710277": 1, "1710278": 1, "1710279": 1, "prewrf2": 1, "1710280_": 1, "runwrf2": 1, "1710281": 1, "prttov": 1, "1710282": 1, "3a": 1, "1710283": 1, "1710284": 1, "1710285": 1, "1710286_": 1, "1710287": 1, "easili": 1, "switch": 1, "between": 1, "clustera": 1, "clusterconfig": 1, "vsc": 1, "userdir": 1, "home": 1, "patha": 1, "myuser": 1, "clusterb": 1, "jet": 1, "pathb": 1, "system": 2, "softwar": 2, "why": 2, "should": 2, "It": 2, "see": 2, "what": 2, "doe": 2, "first": 2, "glanc": 2, "modular": 2, "flexibl": 2, "handl": 2, "without": 2, "sleep": 2, "loop": 2, "bash": 2, "script": 2, "return": 2, "trigger": 2, "anoth": 2, "interfac": 2, "brentp": 2, "how": 2, "work": 2, "There": 2, "two": 2, "kind": 2, "code": 2, "One": 2, "immedi": 2, "later": 2, "The": 2, "instruct": 2, "do": 2, "thing": 2, "tell": 2, "right": 2, "input": 2, "latter": 2, "actual": 2, "Its": 2, "execut": 2, "awai": 2, "when": 2, "assign": 2, "real": 2, "weather": 2, "ye": 2, "convert": 2, "format": 2, "doc": 2, "ucar": 2, "edu": 2, "index": 3, "modul": 3, "search": 3, "page": 3}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"welcom": [2, 3], "dart": [2, 3], "wrf": [2, 3], "document": [2, 3], "content": 2, "": 3, "indic": 3, "tabl": 3}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 57}, "alltitles": {"Welcome to the DART-WRF documentation!": [[2, "welcome-to-the-dart-wrf-documentation"]], "Contents": [[2, "contents"]], "Welcome to DART-WRF\u2019s documentation!": [[3, "welcome-to-dart-wrf-s-documentation"]], "Indices and tables": [[3, "indices-and-tables"]]}, "indexentries": {}}) \ No newline at end of file +Search.setIndex({"docnames": ["api", "example", "generated/dartwrf", "index"], "filenames": ["api.rst", "example.rst", "generated/dartwrf.rst", "index.rst"], "titles": ["<no title>", "Workflow", "dartwrf", "Welcome to the DART-WRF documentation!"], "terms": {"workflow": 3, "configur": 1, "your": 1, "experi": 1, "defin": 1, "simul": 1, "specif": 1, "variabl": 1, "config": 1, "cfg": 1, "py": 1, "http": 1, "github": 1, "com": 1, "lkugler": 1, "dart": 1, "wrf": 1, "blob": 1, "master": 1, "path": 1, "python": [1, 3], "nck": 1, "etc": 1, "cluster": 1, "depend": 1, "ar": 1, "numpi": 1, "panda": 1, "scipi": 1, "xarrai": 1, "netcdf4": 1, "instal": 1, "non": 1, "standard": 1, "packag": [1, 3], "pip": 1, "docopt": 1, "slurmpi": 1, "user": 1, "i": [1, 3], "us": 1, "meta": 1, "routin": 1, "function": 1, "like": 1, "run_en": 1, "which": 1, "schedul": 1, "prepar": 1, "initi": 1, "condit": 1, "from": 1, "input_sound": 1, "1": 1, "start": 1, "time": 1, "begin": 1, "dt": 1, "datetim": 1, "2008": 1, "7": 1, "30": 1, "6": 1, "2": 1, "need": 1, "directori": 1, "certain": 1, "file": 1, "id": 1, "prepare_wrfrundir": 1, "3": 1, "creat": 1, "3d": 1, "run_id": 1, "depends_on": 1, "run": [1, 3], "free": 1, "forecast": 1, "let": 1, "": 1, "sai": 1, "you": 1, "want": 1, "6z": 1, "prior": 1, "an": [1, 3], "assimil": [1, 3], "9z": 1, "Then": 1, "can": 1, "abov": 1, "step": 1, "ensembl": [1, 3], "integr": 1, "here": 1, "end": 1, "until": 1, "input_is_restart": 1, "fals": 1, "output_restart_interv": 1, "total_second": 1, "60": 1, "where": 1, "object": 1, "To": 1, "observ": 1, "thi": 1, "command": 1, "prior_init_tim": 1, "prior_valid_tim": 1, "prior_path_exp": 1, "updat": 1, "data": [1, 3], "In": 1, "order": 1, "continu": 1, "after": 1, "posterior": 1, "increment": 1, "set": 1, "prepare_ic_from_prior": 1, "str": 1, "model": 1, "state": 1, "restart": 1, "update_ic_from_da": 1, "wrfrst": 1, "filter_restart": 1, "copi": 1, "so": 1, "en": 1, "timedelta_integr": 1, "restart_path": 1, "archivedir": 1, "strftime": 1, "y": 1, "m": 1, "d_": 1, "h": 1, "timedelta_btw_assim": 1, "timedelta": 1, "exampl": 1, "generate_fre": 1, "final": 1, "slurm": 1, "submiss": 1, "submit": 1, "job": 1, "queue": 1, "itself": 1, "soon": 1, "resourc": 1, "avail": 1, "most": 1, "onli": 1, "one": 1, "node": 1, "done": 1, "arrai": 1, "across": 1, "e": 1, "g": 1, "10": 1, "squeue": 1, "u": 1, "whoami": 1, "sort": 1, "jobid": 1, "partit": 1, "name": 1, "st": 1, "nodelist": 1, "reason": 1, "1710274": 1, "mem_0384": 1, "prepwrfr": 1, "pd": 1, "0": 1, "00": 1, "prioriti": 1, "1710275": 1, "ic": 1, "1710276": 1, "assim": 1, "42": 1, "1710277": 1, "1710278": 1, "1710279": 1, "prewrf2": 1, "1710280_": 1, "runwrf2": 1, "1710281": 1, "prttov": 1, "1710282": 1, "3a": 1, "1710283": 1, "1710284": 1, "1710285": 1, "1710286_": 1, "1710287": 1, "easili": 1, "switch": 1, "between": 1, "clustera": 1, "clusterconfig": 1, "vsc": 1, "userdir": 1, "home": 1, "patha": 1, "myuser": 1, "clusterb": 1, "jet": 1, "pathb": 1, "system": 3, "softwar": 3, "dartwrf": 3}, "objects": {"": [[2, 0, 0, "-", "dartwrf"]]}, "objtypes": {"0": "py:module"}, "objnames": {"0": ["py", "module", "Python module"]}, "titleterms": {"dartwrf": 2, "welcom": 3, "dart": 3, "wrf": 3, "document": 3, "content": 3, "workflow": 1}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx": 57}, "alltitles": {"dartwrf": [[2, "module-dartwrf"]], "Workflow": [[1, "workflow"]], "Welcome to the DART-WRF documentation!": [[3, "welcome-to-the-dart-wrf-documentation"]], "Contents": [[3, "contents"]]}, "indexentries": {}}) \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index 777a97ef6433627299a29c35e79d3363c9f29dfa..e4ce287f71f518675a7b8a44e81a1b3d55dd4e2f 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -1,3 +1,6 @@ +import os +import sys +sys.path.insert(0, os.path.abspath('../../dartwrf/')) # Configuration file for the Sphinx documentation builder. # -- Project information @@ -15,6 +18,7 @@ extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'sphinx.ext.intersphinx', + 'sphinx.ext.napoleon' ] intersphinx_mapping = { diff --git a/docs/source/conf.py_old b/docs/source/conf.py_old deleted file mode 100644 index f4f84cc48bc5f7c22ea8d173dc39fc8c2af388ff..0000000000000000000000000000000000000000 --- a/docs/source/conf.py_old +++ /dev/null @@ -1,36 +0,0 @@ -# Configuration file for the Sphinx documentation builder. - -# -- Project information - -project = 'DART-WRF' -copyright = '2023, University of Vienna' -author = 'Lukas Kugler' - -release = '0.1' -version = '0.1.0' - -# -- General configuration - -extensions = [ - 'sphinx.ext.duration', - 'sphinx.ext.doctest', - 'sphinx.ext.autodoc', - 'sphinx.ext.autosummary', - 'sphinx.ext.intersphinx', -] - -intersphinx_mapping = { - 'python': ('https://docs.python.org/3/', None), - 'sphinx': ('https://www.sphinx-doc.org/en/master/', None), -} -intersphinx_disabled_domains = ['std'] - -templates_path = ['_templates'] - -# -- Options for HTML output - -html_theme = 'sphinx_rtd_theme' - -# -- Options for EPUB output -epub_show_urls = 'footnote' - diff --git a/docs/source/example.rst b/docs/source/example.rst index 79d4afc15f5cadfaa135380a5df2a7292cf63df2..ee61ceefc852d1a28f33193e0fbe7da2f310930d 100644 --- a/docs/source/example.rst +++ b/docs/source/example.rst @@ -1,6 +1,6 @@ +Workflow +======== - -## Workflow #### Configure your experiment Define simulation specific variables in [`config/cfg.py`](https://github.com/lkugler/DART-WRF/blob/master/config/cfg.py). Define paths for python, ncks, etc. in [`config/clusters.py`](https://github.com/lkugler/DART-WRF/blob/master/config/clusters.py). diff --git a/docs/source/generated/dartwrf.rst b/docs/source/generated/dartwrf.rst new file mode 100644 index 0000000000000000000000000000000000000000..38e693b1d13deeeff6ed090c5ccd87434f62fa05 --- /dev/null +++ b/docs/source/generated/dartwrf.rst @@ -0,0 +1,23 @@ +dartwrf +======= + +.. automodule:: dartwrf + + + + + + + + + + + + + + + + + + + diff --git a/docs/source/index.rst b/docs/source/index.rst index f5bb4268f96d3dd278da6e96d4757be7a82c5743..3b23e27aadb68ffba9a22833a3fc5cd92f1deb04 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -11,7 +11,6 @@ Contents .. toctree:: - usage api - docs/source/example + example