diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle index f89033911cc01499ecd3ba2d404be709dd97318b..4de22428eeca8ded40072d0f48035ee3a8af8500 100644 Binary files a/docs/build/doctrees/environment.pickle and b/docs/build/doctrees/environment.pickle differ diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree index 2bf2672ee88514435c26768885baec1e08c080b6..8c57b541b73c9e4cee4cdfd5ef2b9f57b71bf7a7 100644 Binary files a/docs/build/doctrees/index.doctree and b/docs/build/doctrees/index.doctree differ diff --git a/docs/build/doctrees/index2.doctree b/docs/build/doctrees/index2.doctree deleted file mode 100644 index 797f03dfd3d268169e139908104ec455be0e1e70..0000000000000000000000000000000000000000 Binary files a/docs/build/doctrees/index2.doctree and /dev/null differ diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt index 3b23e27aadb68ffba9a22833a3fc5cd92f1deb04..7d932e88b9f1c2b6b4af1631e907d6f3b061f50d 100644 --- a/docs/build/html/_sources/index.rst.txt +++ b/docs/build/html/_sources/index.rst.txt @@ -5,12 +5,17 @@ DART-WRF is a Python package to run an Ensemble Data Assimilation system with th +.. toctree:: +:maxdepth: 2 +:caption: Contents: -Contents --------- -.. toctree:: - api - example +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/docs/build/html/_sources/index2.rst.txt b/docs/build/html/_sources/index2.rst.txt deleted file mode 100644 index 993e6a3d7d8874f0d3c9ad84933439de14a57f7c..0000000000000000000000000000000000000000 --- a/docs/build/html/_sources/index2.rst.txt +++ /dev/null @@ -1,20 +0,0 @@ -.. DART-WRF documentation master file, created by - sphinx-quickstart on Fri Feb 17 17:22:54 2023. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to DART-WRF's documentation! -==================================== - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/docs/build/html/_static/alabaster.css b/docs/build/html/_static/alabaster.css deleted file mode 100644 index 517d0b29cb1193b1211c8853b58c65cddd1fa4d2..0000000000000000000000000000000000000000 --- a/docs/build/html/_static/alabaster.css +++ /dev/null @@ -1,703 +0,0 @@ -@import url("basic.css"); - -/* -- page layout ----------------------------------------------------------- */ - -body { - font-family: Georgia, serif; - font-size: 17px; - background-color: #fff; - color: #000; - margin: 0; - padding: 0; -} - - -div.document { - width: 940px; - margin: 30px auto 0 auto; -} - -div.documentwrapper { - float: left; - width: 100%; -} - -div.bodywrapper { - margin: 0 0 0 220px; -} - -div.sphinxsidebar { - width: 220px; - font-size: 14px; - line-height: 1.5; -} - -hr { - border: 1px solid #B1B4B6; -} - -div.body { - background-color: #fff; - color: #3E4349; - padding: 0 30px 0 30px; -} - -div.body > .section { - text-align: left; -} - -div.footer { - width: 940px; - margin: 20px auto 30px auto; - font-size: 14px; - color: #888; - text-align: right; -} - -div.footer a { - color: #888; -} - -p.caption { - font-family: inherit; - font-size: inherit; -} - - -div.relations { - display: none; -} - - -div.sphinxsidebar a { - color: #444; - text-decoration: none; - border-bottom: 1px dotted #999; -} - -div.sphinxsidebar a:hover { - border-bottom: 1px solid #999; -} - -div.sphinxsidebarwrapper { - padding: 18px 10px; -} - -div.sphinxsidebarwrapper p.logo { - padding: 0; - margin: -10px 0 0 0px; - text-align: center; -} - -div.sphinxsidebarwrapper h1.logo { - margin-top: -10px; - text-align: center; - margin-bottom: 5px; - text-align: left; -} - -div.sphinxsidebarwrapper h1.logo-name { - margin-top: 0px; -} - -div.sphinxsidebarwrapper p.blurb { - margin-top: 0; - font-style: normal; -} - -div.sphinxsidebar h3, -div.sphinxsidebar h4 { - font-family: Georgia, serif; - color: #444; - font-size: 24px; - font-weight: normal; - margin: 0 0 5px 0; - padding: 0; -} - -div.sphinxsidebar h4 { - font-size: 20px; -} - -div.sphinxsidebar h3 a { - color: #444; -} - -div.sphinxsidebar p.logo a, -div.sphinxsidebar h3 a, -div.sphinxsidebar p.logo a:hover, -div.sphinxsidebar h3 a:hover { - border: none; -} - -div.sphinxsidebar p { - color: #555; - margin: 10px 0; -} - -div.sphinxsidebar ul { - margin: 10px 0; - padding: 0; - color: #000; -} - -div.sphinxsidebar ul li.toctree-l1 > a { - font-size: 120%; -} - -div.sphinxsidebar ul li.toctree-l2 > a { - font-size: 110%; -} - -div.sphinxsidebar input { - border: 1px solid #CCC; - font-family: Georgia, serif; - font-size: 1em; -} - -div.sphinxsidebar hr { - border: none; - height: 1px; - color: #AAA; - background: #AAA; - - text-align: left; - margin-left: 0; - width: 50%; -} - -div.sphinxsidebar .badge { - border-bottom: none; -} - -div.sphinxsidebar .badge:hover { - border-bottom: none; -} - -/* To address an issue with donation coming after search */ -div.sphinxsidebar h3.donation { - margin-top: 10px; -} - -/* -- body styles ----------------------------------------------------------- */ - -a { - color: #004B6B; - text-decoration: underline; -} - -a:hover { - color: #6D4100; - text-decoration: underline; -} - -div.body h1, -div.body h2, -div.body h3, -div.body h4, -div.body h5, -div.body h6 { - font-family: Georgia, serif; - font-weight: normal; - margin: 30px 0px 10px 0px; - padding: 0; -} - -div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; } -div.body h2 { font-size: 180%; } -div.body h3 { font-size: 150%; } -div.body h4 { font-size: 130%; } -div.body h5 { font-size: 100%; } -div.body h6 { font-size: 100%; } - -a.headerlink { - color: #DDD; - padding: 0 4px; - text-decoration: none; -} - -a.headerlink:hover { - color: #444; - background: #EAEAEA; -} - -div.body p, div.body dd, div.body li { - line-height: 1.4em; -} - -div.admonition { - margin: 20px 0px; - padding: 10px 30px; - background-color: #EEE; - border: 1px solid #CCC; -} - -div.admonition tt.xref, div.admonition code.xref, div.admonition a tt { - background-color: #FBFBFB; - border-bottom: 1px solid #fafafa; -} - -div.admonition p.admonition-title { - font-family: Georgia, serif; - font-weight: normal; - font-size: 24px; - margin: 0 0 10px 0; - padding: 0; - line-height: 1; -} - -div.admonition p.last { - margin-bottom: 0; -} - -div.highlight { - background-color: #fff; -} - -dt:target, .highlight { - background: #FAF3E8; -} - -div.warning { - background-color: #FCC; - border: 1px solid #FAA; -} - -div.danger { - background-color: #FCC; - border: 1px solid #FAA; - -moz-box-shadow: 2px 2px 4px #D52C2C; - -webkit-box-shadow: 2px 2px 4px #D52C2C; - box-shadow: 2px 2px 4px #D52C2C; -} - -div.error { - background-color: #FCC; - border: 1px solid #FAA; - -moz-box-shadow: 2px 2px 4px #D52C2C; - -webkit-box-shadow: 2px 2px 4px #D52C2C; - box-shadow: 2px 2px 4px #D52C2C; -} - -div.caution { - background-color: #FCC; - border: 1px solid #FAA; -} - -div.attention { - background-color: #FCC; - border: 1px solid #FAA; -} - -div.important { - background-color: #EEE; - border: 1px solid #CCC; -} - -div.note { - background-color: #EEE; - border: 1px solid #CCC; -} - -div.tip { - background-color: #EEE; - border: 1px solid #CCC; -} - -div.hint { - background-color: #EEE; - border: 1px solid #CCC; -} - -div.seealso { - background-color: #EEE; - border: 1px solid #CCC; -} - -div.topic { - background-color: #EEE; -} - -p.admonition-title { - display: inline; -} - -p.admonition-title:after { - content: ":"; -} - -pre, tt, code { - font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; - font-size: 0.9em; -} - -.hll { - background-color: #FFC; - margin: 0 -12px; - padding: 0 12px; - display: block; -} - -img.screenshot { -} - -tt.descname, tt.descclassname, code.descname, code.descclassname { - font-size: 0.95em; -} - -tt.descname, code.descname { - padding-right: 0.08em; -} - -img.screenshot { - -moz-box-shadow: 2px 2px 4px #EEE; - -webkit-box-shadow: 2px 2px 4px #EEE; - box-shadow: 2px 2px 4px #EEE; -} - -table.docutils { - border: 1px solid #888; - -moz-box-shadow: 2px 2px 4px #EEE; - -webkit-box-shadow: 2px 2px 4px #EEE; - box-shadow: 2px 2px 4px #EEE; -} - -table.docutils td, table.docutils th { - border: 1px solid #888; - padding: 0.25em 0.7em; -} - -table.field-list, table.footnote { - border: none; - -moz-box-shadow: none; - -webkit-box-shadow: none; - box-shadow: none; -} - -table.footnote { - margin: 15px 0; - width: 100%; - border: 1px solid #EEE; - background: #FDFDFD; - font-size: 0.9em; -} - -table.footnote + table.footnote { - margin-top: -15px; - border-top: none; -} - -table.field-list th { - padding: 0 0.8em 0 0; -} - -table.field-list td { - padding: 0; -} - -table.field-list p { - margin-bottom: 0.8em; -} - -/* Cloned from - * https://github.com/sphinx-doc/sphinx/commit/ef60dbfce09286b20b7385333d63a60321784e68 - */ -.field-name { - -moz-hyphens: manual; - -ms-hyphens: manual; - -webkit-hyphens: manual; - hyphens: manual; -} - -table.footnote td.label { - width: .1px; - padding: 0.3em 0 0.3em 0.5em; -} - -table.footnote td { - padding: 0.3em 0.5em; -} - -dl { - margin-left: 0; - margin-right: 0; - margin-top: 0; - padding: 0; -} - -dl dd { - margin-left: 30px; -} - -blockquote { - margin: 0 0 0 30px; - padding: 0; -} - -ul, ol { - /* Matches the 30px from the narrow-screen "li > ul" selector below */ - margin: 10px 0 10px 30px; - padding: 0; -} - -pre { - background: #EEE; - padding: 7px 30px; - margin: 15px 0px; - line-height: 1.3em; -} - -div.viewcode-block:target { - background: #ffd; -} - -dl pre, blockquote pre, li pre { - margin-left: 0; - padding-left: 30px; -} - -tt, code { - background-color: #ecf0f3; - color: #222; - /* padding: 1px 2px; */ -} - -tt.xref, code.xref, a tt { - background-color: #FBFBFB; - border-bottom: 1px solid #fff; -} - -a.reference { - text-decoration: none; - border-bottom: 1px dotted #004B6B; -} - -/* Don't put an underline on images */ -a.image-reference, a.image-reference:hover { - border-bottom: none; -} - -a.reference:hover { - border-bottom: 1px solid #6D4100; -} - -a.footnote-reference { - text-decoration: none; - font-size: 0.7em; - vertical-align: top; - border-bottom: 1px dotted #004B6B; -} - -a.footnote-reference:hover { - border-bottom: 1px solid #6D4100; -} - -a:hover tt, a:hover code { - background: #EEE; -} - - -@media screen and (max-width: 870px) { - - div.sphinxsidebar { - display: none; - } - - div.document { - width: 100%; - - } - - div.documentwrapper { - margin-left: 0; - margin-top: 0; - margin-right: 0; - margin-bottom: 0; - } - - div.bodywrapper { - margin-top: 0; - margin-right: 0; - margin-bottom: 0; - margin-left: 0; - } - - ul { - margin-left: 0; - } - - li > ul { - /* Matches the 30px from the "ul, ol" selector above */ - margin-left: 30px; - } - - .document { - width: auto; - } - - .footer { - width: auto; - } - - .bodywrapper { - margin: 0; - } - - .footer { - width: auto; - } - - .github { - display: none; - } - - - -} - - - -@media screen and (max-width: 875px) { - - body { - margin: 0; - padding: 20px 30px; - } - - div.documentwrapper { - float: none; - background: #fff; - } - - div.sphinxsidebar { - display: block; - float: none; - width: 102.5%; - margin: 50px -30px -20px -30px; - padding: 10px 20px; - background: #333; - color: #FFF; - } - - div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p, - div.sphinxsidebar h3 a { - color: #fff; - } - - div.sphinxsidebar a { - color: #AAA; - } - - div.sphinxsidebar p.logo { - display: none; - } - - div.document { - width: 100%; - margin: 0; - } - - div.footer { - display: none; - } - - div.bodywrapper { - margin: 0; - } - - div.body { - min-height: 0; - padding: 0; - } - - .rtd_doc_footer { - display: none; - } - - .document { - width: auto; - } - - .footer { - width: auto; - } - - .footer { - width: auto; - } - - .github { - display: none; - } -} - - -/* misc. */ - -.revsys-inline { - display: none!important; -} - -/* Make nested-list/multi-paragraph items look better in Releases changelog - * pages. Without this, docutils' magical list fuckery causes inconsistent - * formatting between different release sub-lists. - */ -div#changelog > div.section > ul > li > p:only-child { - margin-bottom: 0; -} - -/* Hide fugly table cell borders in ..bibliography:: directive output */ -table.docutils.citation, table.docutils.citation td, table.docutils.citation th { - border: none; - /* Below needed in some edge cases; if not applied, bottom shadows appear */ - -moz-box-shadow: none; - -webkit-box-shadow: none; - box-shadow: none; -} - - -/* relbar */ - -.related { - line-height: 30px; - width: 100%; - font-size: 0.9rem; -} - -.related.top { - border-bottom: 1px solid #EEE; - margin-bottom: 20px; -} - -.related.bottom { - border-top: 1px solid #EEE; -} - -.related ul { - padding: 0; - margin: 0; - list-style: none; -} - -.related li { - display: inline; -} - -nav#rellinks { - float: right; -} - -nav#rellinks li+li:before { - content: "|"; -} - -nav#breadcrumbs li+li:before { - content: "\00BB"; -} - -/* Hide certain items when printing */ -@media print { - div.related { - display: none; - } -} \ No newline at end of file diff --git a/docs/build/html/_static/custom.css b/docs/build/html/_static/custom.css deleted file mode 100644 index 2a924f1d6a8bc930c5296bdb2d5c2d3e39b04a1c..0000000000000000000000000000000000000000 --- a/docs/build/html/_static/custom.css +++ /dev/null @@ -1 +0,0 @@ -/* This file intentionally left blank. */ diff --git a/docs/build/html/api.html b/docs/build/html/api.html index 2e25becbef3b575856aa5435712b212681133008..be268dd4210289368b317eea01303da497a8b266 100644 --- a/docs/build/html/api.html +++ b/docs/build/html/api.html @@ -17,9 +17,7 @@ <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="next" title="dartwrf" href="generated/dartwrf.html" /> - <link rel="prev" title="Welcome to the DART-WRF documentation!" href="index.html" /> + <link rel="search" title="Search" href="search.html" /> </head> <body class="wy-body-for-nav"> @@ -41,10 +39,8 @@ </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> - + <!-- Local TOC --> + <div class="local-toc"></div> </div> </div> </nav> @@ -80,10 +76,7 @@ </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> + <footer> <hr/> diff --git a/docs/build/html/example.html b/docs/build/html/example.html index e1d61b95a097b68b38fef2f671442c51b1f03fcb..74b0b342f4693f635c63fd4d359aaa54629bdf74 100644 --- a/docs/build/html/example.html +++ b/docs/build/html/example.html @@ -17,8 +17,7 @@ <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="prev" title="dartwrf" href="generated/dartwrf.html" /> + <link rel="search" title="Search" href="search.html" /> </head> <body class="wy-body-for-nav"> @@ -40,11 +39,11 @@ </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> + <!-- Local TOC --> + <div class="local-toc"><ul> +<li><a class="reference internal" href="#">Workflow</a></li> </ul> - +</div> </div> </div> </nav> @@ -170,9 +169,7 @@ clusterB.userdir = ‘/home/pathB/myuser/’ </div> </div> - <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> + <footer> <hr/> diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html index 42493693a4ed5956d7d48d7797661b5bdc2346ac..7e8a1fefc34825d2204d98852251fb65cb92b47f 100644 --- a/docs/build/html/genindex.html +++ b/docs/build/html/genindex.html @@ -38,11 +38,8 @@ </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> - + <!-- Local TOC --> + <div class="local-toc"></div> </div> </div> </nav> @@ -70,33 +67,388 @@ <h1 id="index">Index</h1> <div class="genindex-jumpbox"> - <a href="#D"><strong>D</strong></a> + <a href="#A"><strong>A</strong></a> + | <a href="#B"><strong>B</strong></a> + | <a href="#C"><strong>C</strong></a> + | <a href="#D"><strong>D</strong></a> + | <a href="#E"><strong>E</strong></a> + | <a href="#G"><strong>G</strong></a> + | <a href="#L"><strong>L</strong></a> | <a href="#M"><strong>M</strong></a> + | <a href="#O"><strong>O</strong></a> + | <a href="#P"><strong>P</strong></a> + | <a href="#R"><strong>R</strong></a> + | <a href="#S"><strong>S</strong></a> + | <a href="#T"><strong>T</strong></a> + | <a href="#U"><strong>U</strong></a> + | <a href="#W"><strong>W</strong></a> </div> +<h2 id="A">A</h2> +<table style="width: 100%" class="indextable genindextable"><tr> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="dartwrf.html#dartwrf.utils.append_file">append_file() (in module dartwrf.utils)</a> +</li> + </ul></td> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="dartwrf.html#dartwrf.utils.ClusterConfig.archivedir">archivedir (dartwrf.utils.ClusterConfig property)</a> +</li> + </ul></td> +</tr></table> + +<h2 id="B">B</h2> +<table style="width: 100%" class="indextable genindextable"><tr> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="dartwrf.html#dartwrf.utils.ClusterConfig.backup_scripts">backup_scripts() (dartwrf.utils.ClusterConfig method)</a> +</li> + </ul></td> +</tr></table> + +<h2 id="C">C</h2> +<table style="width: 100%" class="indextable genindextable"><tr> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="dartwrf.obs.html#dartwrf.obs.error_models.calc_obserr_WV">calc_obserr_WV() (in module dartwrf.obs.error_models)</a> +</li> + <li><a href="dartwrf.html#dartwrf.utils.clean_wrfdir">clean_wrfdir() (in module dartwrf.utils)</a> +</li> + <li><a href="dartwrf.obs.html#dartwrf.obs.error_models.cloudimpact">cloudimpact() (in module dartwrf.obs.error_models)</a> +</li> + <li><a href="dartwrf.html#dartwrf.utils.ClusterConfig">ClusterConfig (class in dartwrf.utils)</a> +</li> + <li><a href="dartwrf.html#dartwrf.utils.copy">copy() (in module dartwrf.utils)</a> +</li> + </ul></td> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="dartwrf.html#dartwrf.utils.copy_contents">copy_contents() (in module dartwrf.utils)</a> +</li> + <li><a href="dartwrf.html#dartwrf.utils.copy_scp_srvx8">copy_scp_srvx8() (in module dartwrf.utils)</a> +</li> + <li><a href="dartwrf.html#dartwrf.utils.ClusterConfig.create_job">create_job() (dartwrf.utils.ClusterConfig method)</a> +</li> + <li><a href="dartwrf.html#dartwrf.old_functions.create_obsseq_in_separate_obs">create_obsseq_in_separate_obs() (in module dartwrf.old_functions)</a> +</li> + <li><a href="dartwrf.html#dartwrf.prep_IC_prior.create_updated_wrfinput_from_wrfout">create_updated_wrfinput_from_wrfout() (in module dartwrf.prep_IC_prior)</a> +</li> + <li><a href="dartwrf.html#dartwrf.prep_IC_prior.create_wrfrst_in_WRF_rundir">create_wrfrst_in_WRF_rundir() (in module dartwrf.prep_IC_prior)</a> +</li> + </ul></td> +</tr></table> + <h2 id="D">D</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="dartwrf.html#dartwrf.utils.ClusterConfig.dartrundir">dartrundir (dartwrf.utils.ClusterConfig property)</a> +</li> <li> dartwrf <ul> - <li><a href="generated/dartwrf.html#module-dartwrf">module</a> + <li><a href="dartwrf.html#module-dartwrf">module</a>, <a href="generated/dartwrf.html#module-dartwrf">[1]</a> +</li> + </ul></li> + <li> + dartwrf.obs + + <ul> + <li><a href="dartwrf.obs.html#module-dartwrf.obs">module</a> +</li> + </ul></li> + <li> + dartwrf.obs.calculate_obs_locations + + <ul> + <li><a href="dartwrf.obs.html#module-dartwrf.obs.calculate_obs_locations">module</a> +</li> + </ul></li> + <li> + dartwrf.obs.error_models + + <ul> + <li><a href="dartwrf.obs.html#module-dartwrf.obs.error_models">module</a> +</li> + </ul></li> + <li> + dartwrf.obsseq + + <ul> + <li><a href="dartwrf.html#module-dartwrf.obsseq">module</a> +</li> + </ul></li> + <li> + dartwrf.obsseq_to_netcdf + + <ul> + <li><a href="dartwrf.html#module-dartwrf.obsseq_to_netcdf">module</a> +</li> + </ul></li> + <li> + dartwrf.old_functions + + <ul> + <li><a href="dartwrf.html#module-dartwrf.old_functions">module</a> </li> </ul></li> </ul></td> + <td style="width: 33%; vertical-align: top;"><ul> + <li> + dartwrf.prep_IC_prior + + <ul> + <li><a href="dartwrf.html#module-dartwrf.prep_IC_prior">module</a> +</li> + </ul></li> + <li> + dartwrf.run_obs_diag + + <ul> + <li><a href="dartwrf.html#module-dartwrf.run_obs_diag">module</a> +</li> + </ul></li> + <li> + dartwrf.update_IC + + <ul> + <li><a href="dartwrf.html#module-dartwrf.update_IC">module</a> +</li> + </ul></li> + <li> + dartwrf.utils + + <ul> + <li><a href="dartwrf.html#module-dartwrf.utils">module</a> +</li> + </ul></li> + <li> + dartwrf.wrfinput_add_geo + + <ul> + <li><a href="dartwrf.html#module-dartwrf.wrfinput_add_geo">module</a> +</li> + </ul></li> + <li> + dartwrf.wrfout_add_geo + + <ul> + <li><a href="dartwrf.html#module-dartwrf.wrfout_add_geo">module</a> +</li> + </ul></li> + <li><a href="dartwrf.html#dartwrf.obsseq.degrees_to_rad">degrees_to_rad() (in module dartwrf.obsseq)</a> +</li> + <li><a href="dartwrf.html#dartwrf.obsseq.ObsRecord.determine_nlayers">determine_nlayers() (dartwrf.obsseq.ObsRecord method)</a> +</li> + </ul></td> +</tr></table> + +<h2 id="E">E</h2> +<table style="width: 100%" class="indextable genindextable"><tr> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="dartwrf.obs.html#dartwrf.obs.calculate_obs_locations.evenly_on_grid">evenly_on_grid() (in module dartwrf.obs.calculate_obs_locations)</a> +</li> + </ul></td> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="dartwrf.html#dartwrf.utils.ExperimentConfiguration">ExperimentConfiguration (class in dartwrf.utils)</a> +</li> + </ul></td> +</tr></table> + +<h2 id="G">G</h2> +<table style="width: 100%" class="indextable genindextable"><tr> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="dartwrf.html#dartwrf.obsseq.ObsRecord.get_from_cartesian_grid">get_from_cartesian_grid() (dartwrf.obsseq.ObsRecord method)</a> +</li> + <li><a href="dartwrf.html#dartwrf.obsseq.ObsRecord.get_lon_lat">get_lon_lat() (dartwrf.obsseq.ObsRecord method)</a> +</li> + <li><a href="dartwrf.html#dartwrf.obsseq.ObsRecord.get_posterior_Hx">get_posterior_Hx() (dartwrf.obsseq.ObsRecord method)</a> +</li> + </ul></td> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="dartwrf.html#dartwrf.obsseq.ObsSeq.get_preamble_content">get_preamble_content() (dartwrf.obsseq.ObsSeq method)</a> +</li> + <li><a href="dartwrf.html#dartwrf.obsseq.ObsRecord.get_prior_Hx">get_prior_Hx() (dartwrf.obsseq.ObsRecord method)</a> +</li> + <li><a href="dartwrf.html#dartwrf.obsseq.ObsRecord.get_truth_Hx">get_truth_Hx() (dartwrf.obsseq.ObsRecord method)</a> +</li> + </ul></td> +</tr></table> + +<h2 id="L">L</h2> +<table style="width: 100%" class="indextable genindextable"><tr> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="dartwrf.html#dartwrf.utils.link_contents">link_contents() (in module dartwrf.utils)</a> +</li> + </ul></td> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="dartwrf.html#dartwrf.obsseq_to_netcdf.listdir_dirs">listdir_dirs() (in module dartwrf.obsseq_to_netcdf)</a> +</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><a href="dartwrf.html#dartwrf.utils.mkdir">mkdir() (in module dartwrf.utils)</a> +</li> <li> module <ul> - <li><a href="generated/dartwrf.html#module-dartwrf">dartwrf</a> + <li><a href="dartwrf.html#module-dartwrf">dartwrf</a>, <a href="generated/dartwrf.html#module-dartwrf">[1]</a> +</li> + <li><a href="dartwrf.obs.html#module-dartwrf.obs">dartwrf.obs</a> +</li> + <li><a href="dartwrf.obs.html#module-dartwrf.obs.calculate_obs_locations">dartwrf.obs.calculate_obs_locations</a> +</li> + <li><a href="dartwrf.obs.html#module-dartwrf.obs.error_models">dartwrf.obs.error_models</a> +</li> + <li><a href="dartwrf.html#module-dartwrf.obsseq">dartwrf.obsseq</a> +</li> + <li><a href="dartwrf.html#module-dartwrf.obsseq_to_netcdf">dartwrf.obsseq_to_netcdf</a> +</li> + <li><a href="dartwrf.html#module-dartwrf.old_functions">dartwrf.old_functions</a> +</li> + <li><a href="dartwrf.html#module-dartwrf.prep_IC_prior">dartwrf.prep_IC_prior</a> +</li> + <li><a href="dartwrf.html#module-dartwrf.run_obs_diag">dartwrf.run_obs_diag</a> +</li> + <li><a href="dartwrf.html#module-dartwrf.update_IC">dartwrf.update_IC</a> +</li> + <li><a href="dartwrf.html#module-dartwrf.utils">dartwrf.utils</a> +</li> + <li><a href="dartwrf.html#module-dartwrf.wrfinput_add_geo">dartwrf.wrfinput_add_geo</a> +</li> + <li><a href="dartwrf.html#module-dartwrf.wrfout_add_geo">dartwrf.wrfout_add_geo</a> +</li> + </ul></li> + </ul></td> +</tr></table> + +<h2 id="O">O</h2> +<table style="width: 100%" class="indextable genindextable"><tr> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="dartwrf.html#dartwrf.old_functions.obs_operator_nature">obs_operator_nature() (in module dartwrf.old_functions)</a> +</li> + <li><a href="dartwrf.html#dartwrf.obsseq.ObsSeq.obs_to_dict">obs_to_dict() (dartwrf.obsseq.ObsSeq method)</a> +</li> + <li><a href="dartwrf.html#dartwrf.obsseq.ObsRecord">ObsRecord (class in dartwrf.obsseq)</a> +</li> + </ul></td> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="dartwrf.html#dartwrf.obsseq.ObsSeq">ObsSeq (class in dartwrf.obsseq)</a> +</li> + <li><a href="dartwrf.obs.html#dartwrf.obs.error_models.OE_model_harnisch_WV62">OE_model_harnisch_WV62() (in module dartwrf.obs.error_models)</a> +</li> + <li><a href="dartwrf.obs.html#dartwrf.obs.error_models.OE_model_harnisch_WV73">OE_model_harnisch_WV73() (in module dartwrf.obs.error_models)</a> +</li> + </ul></td> +</tr></table> + +<h2 id="P">P</h2> +<table style="width: 100%" class="indextable genindextable"><tr> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="dartwrf.html#dartwrf.obsseq.ObsSeq.plot">plot() (dartwrf.obsseq.ObsSeq method)</a> +</li> + <li><a href="dartwrf.html#dartwrf.obsseq.plot_box">plot_box() (in module dartwrf.obsseq)</a> +</li> + </ul></td> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="dartwrf.html#dartwrf.run_obs_diag.prepare">prepare() (in module dartwrf.run_obs_diag)</a> +</li> + <li><a href="dartwrf.html#dartwrf.utils.print">print() (in module dartwrf.utils)</a> +</li> + </ul></td> +</tr></table> + +<h2 id="R">R</h2> +<table style="width: 100%" class="indextable genindextable"><tr> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="dartwrf.html#dartwrf.obsseq.rad_to_degrees">rad_to_degrees() (in module dartwrf.obsseq)</a> +</li> + <li><a href="dartwrf.html#dartwrf.obsseq.ObsSeq.read_preamble">read_preamble() (dartwrf.obsseq.ObsSeq method)</a> +</li> + <li><a href="dartwrf.html#dartwrf.old_functions.read_prior_obs">read_prior_obs() (in module dartwrf.old_functions)</a> +</li> + <li><a href="dartwrf.html#dartwrf.old_functions.read_truth_obs_obsseq">read_truth_obs_obsseq() (in module dartwrf.old_functions)</a> +</li> + <li><a href="dartwrf.html#dartwrf.old_functions.recycle_output">recycle_output() (in module dartwrf.old_functions)</a> +</li> + <li><a href="dartwrf.html#dartwrf.old_functions.replace_errors_obsseqout">replace_errors_obsseqout() (in module dartwrf.old_functions)</a> +</li> + </ul></td> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="dartwrf.html#dartwrf.utils.Shellslurm.run">run() (dartwrf.utils.Shellslurm method)</a> + + <ul> + <li><a href="dartwrf.html#dartwrf.wrfinput_add_geo.run">(in module dartwrf.wrfinput_add_geo)</a> +</li> + <li><a href="dartwrf.html#dartwrf.wrfout_add_geo.run">(in module dartwrf.wrfout_add_geo)</a> </li> </ul></li> + <li><a href="dartwrf.html#dartwrf.old_functions.run_Hx">run_Hx() (in module dartwrf.old_functions)</a> +</li> + <li><a href="dartwrf.html#dartwrf.run_obs_diag.run_obs_seq_to_netcdf">run_obs_seq_to_netcdf() (in module dartwrf.run_obs_diag)</a> +</li> + <li><a href="dartwrf.html#dartwrf.run_obs_diag.run_obsdiag">run_obsdiag() (in module dartwrf.run_obs_diag)</a> +</li> + </ul></td> +</tr></table> + +<h2 id="S">S</h2> +<table style="width: 100%" class="indextable genindextable"><tr> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="dartwrf.html#dartwrf.utils.script_to_str">script_to_str() (in module dartwrf.utils)</a> +</li> + <li><a href="dartwrf.html#dartwrf.utils.ClusterConfig.scripts_rundir">scripts_rundir (dartwrf.utils.ClusterConfig property)</a> +</li> + <li><a href="dartwrf.html#dartwrf.utils.sed_inplace">sed_inplace() (in module dartwrf.utils)</a> +</li> + <li><a href="dartwrf.html#dartwrf.utils.ClusterConfig.setup">setup() (dartwrf.utils.ClusterConfig method)</a> +</li> + </ul></td> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="dartwrf.html#dartwrf.utils.shell">shell() (in module dartwrf.utils)</a> +</li> + <li><a href="dartwrf.html#dartwrf.utils.Shellslurm">Shellslurm (class in dartwrf.utils)</a> +</li> + <li><a href="dartwrf.obs.html#dartwrf.obs.calculate_obs_locations.square_array_from_domaincenter">square_array_from_domaincenter() (in module dartwrf.obs.calculate_obs_locations)</a> +</li> + <li><a href="dartwrf.html#dartwrf.obsseq.ObsRecord.superob">superob() (dartwrf.obsseq.ObsRecord method)</a> +</li> + <li><a href="dartwrf.html#dartwrf.utils.symlink">symlink() (in module dartwrf.utils)</a> +</li> + </ul></td> +</tr></table> + +<h2 id="T">T</h2> +<table style="width: 100%" class="indextable genindextable"><tr> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="dartwrf.html#dartwrf.obsseq.ObsSeq.to_dart">to_dart() (dartwrf.obsseq.ObsSeq method)</a> +</li> + </ul></td> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="dartwrf.html#dartwrf.obsseq.ObsSeq.to_pandas">to_pandas() (dartwrf.obsseq.ObsSeq method)</a> +</li> + <li><a href="dartwrf.html#dartwrf.utils.try_remove">try_remove() (in module dartwrf.utils)</a> +</li> + </ul></td> +</tr></table> + +<h2 id="U">U</h2> +<table style="width: 100%" class="indextable genindextable"><tr> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="dartwrf.html#dartwrf.update_IC.update_initials_in_WRF_rundir">update_initials_in_WRF_rundir() (in module dartwrf.update_IC)</a> +</li> + </ul></td> +</tr></table> + +<h2 id="W">W</h2> +<table style="width: 100%" class="indextable genindextable"><tr> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="dartwrf.html#dartwrf.utils.ClusterConfig.wrf_rundir">wrf_rundir() (dartwrf.utils.ClusterConfig method)</a> +</li> + </ul></td> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="dartwrf.html#dartwrf.run_obs_diag.write_input_filelist">write_input_filelist() (in module dartwrf.run_obs_diag)</a> +</li> </ul></td> </tr></table> diff --git a/docs/build/html/index.html b/docs/build/html/index.html index 741af69e45e7a35b9e2be41247449fc57b9b8af8..2ccfe02b30c9a5d6fcff49542da350e83f59cc3a 100644 --- a/docs/build/html/index.html +++ b/docs/build/html/index.html @@ -17,8 +17,7 @@ <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="next" title="<no title>" href="api.html" /> + <link rel="search" title="Search" href="search.html" /> </head> <body class="wy-body-for-nav"> @@ -40,11 +39,12 @@ </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> + <!-- Local TOC --> + <div class="local-toc"><ul> +<li><a class="reference internal" href="#">Welcome to the DART-WRF documentation!</a></li> +<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li> </ul> - +</div> </div> </div> </nav> @@ -72,23 +72,30 @@ <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> <p>DART-WRF is a Python package to run an Ensemble Data Assimilation system with the software packages DART and WRF.</p> -<section id="contents"> -<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> +<dl class="field-list simple"> +<dt class="field-odd">maxdepth<span class="colon">:</span></dt> +<dd class="field-odd"><p>2</p> +</dd> +<dt class="field-even">caption<span class="colon">:</span></dt> +<dd class="field-even"><p>Contents:</p> +</dd> +</dl> </section> +<section id="indices-and-tables"> +<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this heading"></a></h1> +<ul class="simple"> +<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li> +<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li> +<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li> +</ul> </section> </div> </div> - <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> + <footer> <hr/> diff --git a/docs/build/html/index2.html b/docs/build/html/index2.html deleted file mode 100644 index 1b938bb5378ac4b19c9aedcbb202e1b9902eb4c6..0000000000000000000000000000000000000000 --- a/docs/build/html/index2.html +++ /dev/null @@ -1,110 +0,0 @@ - -<!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 DART-WRF’s 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> - <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" /> - - </head><body> - - - <div class="document"> - <div class="documentwrapper"> - <div class="bodywrapper"> - - - <div class="body" role="main"> - - <section id="welcome-to-dart-wrf-s-documentation"> -<h1>Welcome to DART-WRF’s documentation!<a class="headerlink" href="#welcome-to-dart-wrf-s-documentation" title="Permalink to this heading">¶</a></h1> -<div class="toctree-wrapper compound"> -</div> -</section> -<section id="indices-and-tables"> -<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this heading">¶</a></h1> -<ul class="simple"> -<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li> -<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li> -<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li> -</ul> -</section> - - - </div> - - </div> - </div> - <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> - <div class="sphinxsidebarwrapper"> -<h1 class="logo"><a href="#">DART-WRF</a></h1> - - - - - - - - -<h3>Navigation</h3> - -<div class="relations"> -<h3>Related Topics</h3> -<ul> - <li><a href="#">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> - - - - - - - - - </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/index2.rst.txt" - rel="nofollow">Page source</a> - </div> - - - - - </body> -</html> \ No newline at end of file diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv index c8d516c930bfdbaf37a0b7015513febd3ad2d996..f5d4904a27e367a81b757c1c6912ced49a7e969e 100644 --- a/docs/build/html/objects.inv +++ b/docs/build/html/objects.inv @@ -2,4 +2,10 @@ # Project: DART-WRF # Version: # The remainder of this file is compressed using zlib. -xڅ�M�0����֏�A��0Tع�� �1j���[��om��I�j�NP5���f�pF�A��t\�5C���PU W҉�9��k���y��.��V�]�J�f>\N���״��{�.O�t�V1ꈦ��*���Q���s�����"P\�@X-w���ɛEG�J�"��ǰ�����m�yl/��� �}�WT!/>E����<Ug)�� \ No newline at end of file +xڭXKo�6��W�h��4-�A�pS4�"�]�G�K�HfHګߡ(y���������͓3%������o:+����f���d^m������w��j��[��� � +�E�$�шi+xP�|U���Y���d��E#�Z��9�ZV�9r�y�vh;&mǕ``�@���0�u�� ���;p4ʋ������H��Q&�&��$�]F�m��s\�B���_����7 ,�$4�~&�9'P+�r�S�Ѽ�1�p���g!瞠�?�x%��cB�~����S�?���\N0�C=���nKѷ9� +�������&,�*$��I%��N�*i.���!H:�B%�q#y�!��G��Y�_� +/�����a$hN]N@A�]E�:�[�|� +)Cp�Z�i�/?G��$7Ҥ�2̃�8NU)3�u�B�����NE�Z��#W�A���RC%zA����b��p�`C��Ա�lь�t �j�cﯳG�R�9�Lt2�CmP���� +�Y$��!�����l�s��0y$�Y*�/2q����; �ՇZ�ɔb�#*���!���D9��"'>��/eTP\��`ƠtYm����sm�N�W5�\�Q���:L%-��,[.�c^�rae;\���?k/?Ki��Z�FS�W`�]�94?Sb-ǻ#�:��e����cA��@k�#vU�tHK��� .:8���A��#� +��r�tG�P/����2�V�Rlw_��R&�A�aI���Bi�z+�t](�T+��]re(`�:��Z������������s�R��k˄r��п�V4�� ���Wc������|ۜf4����ٛ�fzIi���F,y���n�ʘ;��;m��=-�!���UF�q�h�=��ټ�}��:m�g;�@�A�Qh~���� ]�S�*�7W�a��L����,6G��{�Թ!3�����S�6�R<�[�90�e�m^����/[z�� \ No newline at end of file diff --git a/docs/build/html/search.html b/docs/build/html/search.html index 51336d1c30e10233f99d713a5918c0bb9c4720ef..e06b1dd7a77f2915a729436e75a5bad3656ded1d 100644 --- a/docs/build/html/search.html +++ b/docs/build/html/search.html @@ -41,11 +41,8 @@ </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> - + <!-- Local TOC --> + <div class="local-toc"></div> </div> </div> </nav> diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js index 6ea2ae123d033ea6ebee33b3fe181969a2a7d268..fb8803a81d214df89002e33c61479b267798dca0 100644 --- a/docs/build/html/searchindex.js +++ b/docs/build/html/searchindex.js @@ -1 +1 @@ -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 +Search.setIndex({"docnames": ["api", "dartwrf", "dartwrf.obs", "example", "generated/dartwrf", "index", "modules"], "filenames": ["api.rst", "dartwrf.rst", "dartwrf.obs.rst", "example.rst", "generated/dartwrf.rst", "index.rst", "modules.rst"], "titles": ["<no title>", "dartwrf package", "dartwrf.obs package", "Workflow", "dartwrf", "Welcome to the DART-WRF documentation!", "dartwrf"], "terms": {"ob": [1, 6], "calculate_obs_loc": [1, 6], "evenly_on_grid": [1, 2], "square_array_from_domaincent": [1, 2], "error_model": [1, 6], "oe_model_harnisch_wv62": [1, 2], "oe_model_harnisch_wv73": [1, 2], "calc_obserr_wv": [1, 2], "cloudimpact": [1, 2], "read": 1, "modifi": 1, "save": 1, "dart": [1, 3], "obs_seq": [1, 2], "file": [1, 2, 3], "Not": 1, "usabl": 1, "creat": [1, 2, 3], "sinc": 1, "doe": 1, "know": 1, "which": [1, 2, 3], "metadata": [1, 2], "i": [1, 3, 5], "necessari": 1, "each": 1, "type": [1, 2], "class": 1, "obsrecord": [1, 6], "data": [1, 3, 5], "none": 1, "index": [1, 5], "extensionarrai": 1, "ndarrai": 1, "seri": 1, "list": 1, "rang": 1, "column": 1, "dtype": 1, "extensiondtyp": 1, "str": [1, 2, 3], "complex": 1, "bool": 1, "object": [1, 3], "copi": [1, 3, 6], "base": 1, "datafram": 1, "instanc": 1, "provid": 1, "addit": 1, "method": 1, "pd": [1, 3], "insid": 1, "an": [1, 3, 5], "determine_nlay": [1, 6], "get_from_cartesian_grid": [1, 6], "j": 1, "k": 1, "get": 1, "observ": [1, 2, 3], "us": [1, 3], "cartesian": 1, "grid": [1, 2], "indic": 1, "ix": 1, "ii": 1, "iz": 1, "get_lon_lat": [1, 6], "get_posterior_hx": [1, 6], "return": [1, 2], "posterior": [1, 3], "hx": 1, "arrai": [1, 2, 3], "n_ob": [1, 2], "n_en": 1, "get_prior_hx": [1, 6], "prior": [1, 3], "get_truth_hx": [1, 6], "superob": [1, 6], "window_km": 1, "select": 1, "subset": 1, "averag": 1, "overwrit": 1, "exist": 1, "todo": 1, "allow": 1, "differ": 1, "kind": 1, "loc3d": 1, "mean": 1, "from": [1, 2, 3], "first": 1, "box": 1, "thi": [1, 3], "routin": [1, 3], "discard": 1, "round": 1, "off": 1, "e": [1, 2, 3], "g": [1, 2, 3], "31": 1, "5": [1, 2], "window": 1, "process": 1, "paramet": 1, "numer": 1, "horizont": 1, "edg": 1, "length": 1, "includ": 1, "25x25": 1, "km": [1, 2], "densiti": 1, "x": 1, "filepath": 1, "manipul": 1, "out": [1, 2], "final": [1, 3], "get_preamble_cont": [1, 6], "split": 1, "two": 1, "part": 1, "1": [1, 3], "line": 1, "until": [1, 3], "messag": 1, "2": [1, 3, 5], "obs_to_dict": [1, 6], "convert": 1, "dictionari": 1, "plot": [1, 6], "f_out": 1, "map_obs_superob": 1, "png": 1, "read_preambl": [1, 6], "defin": [1, 2, 3], "self": 1, "obstyp": 1, "tupl": [1, 2], "kind_nr": 1, "kind_descriptor": 1, "to_dart": [1, 6], "f": 1, "write": 1, "format": 1, "path": [1, 3], "to_panda": [1, 6], "row": 1, "degrees_to_rad": [1, 6], "degr": 1, "convent": 1, "radian": 1, "plot_box": [1, 6], "m": [1, 3], "lat": [1, 2], "lon": [1, 2], "label": 1, "kwarg": 1, "draw": 1, "bound": 1, "mpl_toolkit": 1, "basemap": 1, "np": [1, 2], "rad_to_degre": [1, 6], "rad": 1, "degre": 1, "listdir_dir": [1, 6], "create_obsseq_in_separate_ob": [1, 6], "time_dt": 1, "obscfg": 1, "obs_error": 1, "fals": [1, 3], "archive_obs_coord": 1, "one": [1, 3], "dt": [1, 3], "datetim": [1, 3], "time": [1, 2, 3], "dict": 1, "int": 1, "valu": 1, "error": [1, 2], "standard": [1, 3], "deviat": [1, 2], "0": [1, 3], "zero": [1, 2], "folder": 1, "channel_id": 1, "seviri": 1, "channel": [1, 2], "number": 1, "see": 1, "http": [1, 3], "nwp": 1, "saf": 1, "eumetsat": 1, "download": 1, "rtcoef_rttov12": 1, "ir_srf": 1, "rtcoef_msg_4_seviri_srf": 1, "html": 1, "coord": 1, "obserr_std": 1, "shape": 1, "gaussian": 1, "std": [1, 2], "dev": 1, "ad": 1, "truth": 1, "where": [1, 3], "obs_operator_natur": [1, 6], "read_prior_ob": [1, 6], "f_obs_prior": 1, "docstr": 1, "read_truth_obs_obsseq": [1, 6], "true": [1, 2], "recycle_output": [1, 6], "output": 1, "assimil": [1, 2, 3, 5], "filter": 1, "input": 1, "anoth": 1, "specif": [1, 3], "state": [1, 3], "field": 1, "filter_restart_d01": 1, "000x": 1, "wrfout": 1, "advance_temp": 1, "replace_errors_obsseqout": [1, 6], "new_error": 1, "replac": 1, "must": 1, "match": 1, "run_hx": [1, 6], "assum": 1, "ensembl": [1, 3, 5], "alreadi": 1, "link": 1, "wrfout_d01": 1, "non": [1, 3], "create_updated_wrfinput_from_wrfout": [1, 6], "prior_init_tim": [1, 3], "prior_path_exp": [1, 3], "new_start_tim": 1, "same": 1, "create_wrfout_in_archivedir": 1, "wrfinput": 1, "wrf": [1, 3], "run": [1, 3, 5, 6], "directori": [1, 3], "create_wrfrst_in_wrf_rundir": [1, 6], "wrfrst": [1, 3], "run_wrf": 1, "next": 1, "prepar": [1, 3, 6], "obserr_iszero": 1, "run_obs_seq_to_netcdf": [1, 6], "obs_epoch": 1, "nc": 1, "run_obsdiag": [1, 6], "obsdiag": 1, "write_input_filelist": [1, 6], "update_initials_in_wrf_rundir": [1, 6], "updat": [1, 3], "0001": 1, "preceed": 1, "assim_stage0": 1, "clusterconfig": [1, 3, 6], "exp": 1, "collect": 1, "variabl": [1, 3], "code": 1, "later": 1, "properti": 1, "archivedir": [1, 3, 6], "backup_script": [1, 6], "script": 1, "configur": [1, 3], "archiv": 1, "dir": 1, "create_job": [1, 6], "arg": 1, "cfg_updat": 1, "shortcut": 1, "slurmpi": [1, 3], "": [1, 3], "keep": 1, "certain": [1, 3], "default": 1, "onli": [1, 3], "some": 1, "github": [1, 3], "com": [1, 3], "brentp": 1, "depend": [1, 3], "cluster": [1, 3], "config": [1, 3], "either": 1, "local": 1, "via": 1, "slurm": [1, 3], "dartrundir": [1, 6], "scripts_rundir": [1, 6], "setup": [1, 6], "wrf_rundir": [1, 6], "ien": 1, "experimentconfigur": [1, 6], "shellslurm": [1, 6], "like": [1, 3], "append_fil": [1, 6], "f_main": 1, "f_gets_append": 1, "clean_wrfdir": [1, 6], "src": 1, "dst": 1, "remove_if_exist": 1, "copy_cont": [1, 6], "copy_scp_srvx8": [1, 6], "link_cont": [1, 6], "mkdir": [1, 6], "print": [1, 6], "script_to_str": [1, 6], "sed_inplac": [1, 6], "filenam": 1, "pattern": 1, "repl": 1, "shell": [1, 6], "symlink": [1, 6], "try_remov": [1, 6], "add": 1, "geogrid": 1, "need": [1, 3], "ideal": 1, "ex": 1, "take": 1, "mapfac": 1, "so": [1, 2, 3], "thei": 1, "ar": [1, 2, 3], "consist": 1, "do": 1, "chang": 1, "hgt_m": 1, "would": 1, "alter": 1, "dynam": 1, "have": 1, "impact": 1, "exampl": [1, 3], "call": 1, "py": [1, 3], "geo_em": 1, "d01": 1, "wrfinput_d01": 1, "geo_data_fil": 1, "wrfinput_fil": 1, "georefer": 1, "wrfout_fil": 1, "The": 2, "function": [2, 3], "here": [2, 3], "These": 2, "templat": 2, "locat": 2, "accord": 2, "gener": 2, "subsequ": 2, "omit_covloc_radius_on_boundari": 2, "spread": 2, "evenli": 2, "over": 2, "domain": 2, "leav": 2, "distanc": 2, "border": 2, "increment": [2, 3], "boundari": 2, "50": 2, "coordin": 2, "distance_between_obs_km": 2, "equal": 2, "space": 2, "satellit": 2, "everi": 2, "4": 2, "ny": 2, "nx": 2, "10": [2, 3], "dy": 2, "south_north": 2, "direct": 2, "dx": 2, "west_east": 2, "ci": 2, "hx_natur": 2, "hx_prior": 2, "calcul": 2, "parametr": 2, "param": 2, "dim": 2, "ensemble_memb": 2, "bt_mod": 2, "bt_ob": 2, "follow": 2, "harnisch": 2, "2016": 2, "figur": 2, "3": [2, 3], "your": 3, "experi": 3, "simul": 3, "cfg": 3, "lkugler": 3, "blob": 3, "master": 3, "python": [3, 5], "nck": 3, "etc": 3, "numpi": 3, "panda": 3, "scipi": 3, "xarrai": 3, "netcdf4": 3, "instal": 3, "packag": [3, 5, 6], "pip": 3, "docopt": 3, "user": 3, "meta": 3, "run_en": 3, "schedul": 3, "initi": 3, "condit": 3, "input_sound": 3, "start": 3, "begin": 3, "2008": 3, "7": 3, "30": 3, "6": 3, "id": 3, "prepare_wrfrundir": [3, 6], "3d": 3, "run_id": 3, "depends_on": 3, "free": 3, "forecast": 3, "let": 3, "sai": 3, "you": 3, "want": 3, "6z": 3, "9z": 3, "Then": 3, "can": 3, "abov": 3, "step": 3, "integr": 3, "end": 3, "input_is_restart": 3, "output_restart_interv": 3, "total_second": 3, "60": 3, "To": 3, "command": 3, "prior_valid_tim": 3, "In": 3, "order": 3, "continu": 3, "after": 3, "set": 3, "prepare_ic_from_prior": 3, "model": 3, "restart": 3, "update_ic_from_da": 3, "filter_restart": 3, "en": 3, "timedelta_integr": 3, "restart_path": 3, "strftime": 3, "y": 3, "d_": 3, "h": 3, "timedelta_btw_assim": 3, "timedelta": 3, "generate_fre": 3, "submiss": 3, "submit": 3, "job": 3, "queue": 3, "itself": 3, "soon": 3, "resourc": 3, "avail": 3, "most": 3, "node": 3, "done": 3, "across": 3, "squeue": 3, "u": 3, "whoami": 3, "sort": 3, "jobid": 3, "partit": 3, "name": 3, "st": 3, "nodelist": 3, "reason": 3, "1710274": 3, "mem_0384": 3, "prepwrfr": 3, "00": 3, "prioriti": 3, "1710275": 3, "ic": 3, "1710276": 3, "assim": 3, "42": 3, "1710277": 3, "1710278": 3, "1710279": 3, "prewrf2": 3, "1710280_": 3, "runwrf2": 3, "1710281": 3, "prttov": 3, "1710282": 3, "3a": 3, "1710283": 3, "1710284": 3, "1710285": 3, "1710286_": 3, "1710287": 3, "easili": 3, "switch": 3, "between": 3, "clustera": 3, "vsc": 3, "userdir": 3, "home": 3, "patha": 3, "myuser": 3, "clusterb": 3, "jet": 3, "pathb": 3, "system": 5, "softwar": 5, "maxdepth": 5, "caption": 5, "content": [5, 6], "modul": [5, 6], "search": 5, "page": 5, "subpackag": 6, "submodul": 6, "assim_synth_ob": 6, "cleanup_exp": 6, "create_obs_upfront": 6, "create_obsseq": 6, "create_wbubble_wrfinput": 6, "evaluate_posterior": 6, "evaluate_prior": 6, "link_dart_rttov": 6, "obsseq": 6, "obsseq_2dim": 6, "obsseq_to_netcdf": 6, "old_funct": 6, "prep_ic_prior": 6, "prepare_namelist": 6, "run_obs_diag": 6, "update_": 6, "util": 6, "wrfinput_add_geo": 6, "wrfout_add_geo": 6}, "objects": {"": [[4, 0, 0, "-", "dartwrf"]], "dartwrf": [[2, 0, 0, "-", "obs"], [1, 0, 0, "-", "obsseq"], [1, 0, 0, "-", "obsseq_to_netcdf"], [1, 0, 0, "-", "old_functions"], [1, 0, 0, "-", "prep_IC_prior"], [1, 0, 0, "-", "run_obs_diag"], [1, 0, 0, "-", "update_IC"], [1, 0, 0, "-", "utils"], [1, 0, 0, "-", "wrfinput_add_geo"], [1, 0, 0, "-", "wrfout_add_geo"]], "dartwrf.obs": [[2, 0, 0, "-", "calculate_obs_locations"], [2, 0, 0, "-", "error_models"]], "dartwrf.obs.calculate_obs_locations": [[2, 1, 1, "", "evenly_on_grid"], [2, 1, 1, "", "square_array_from_domaincenter"]], "dartwrf.obs.error_models": [[2, 1, 1, "", "OE_model_harnisch_WV62"], [2, 1, 1, "", "OE_model_harnisch_WV73"], [2, 1, 1, "", "calc_obserr_WV"], [2, 1, 1, "", "cloudimpact"]], "dartwrf.obsseq": [[1, 2, 1, "", "ObsRecord"], [1, 2, 1, "", "ObsSeq"], [1, 1, 1, "", "degrees_to_rad"], [1, 1, 1, "", "plot_box"], [1, 1, 1, "", "rad_to_degrees"]], "dartwrf.obsseq.ObsRecord": [[1, 3, 1, "", "determine_nlayers"], [1, 3, 1, "", "get_from_cartesian_grid"], [1, 3, 1, "", "get_lon_lat"], [1, 3, 1, "", "get_posterior_Hx"], [1, 3, 1, "", "get_prior_Hx"], [1, 3, 1, "", "get_truth_Hx"], [1, 3, 1, "", "superob"]], "dartwrf.obsseq.ObsSeq": [[1, 3, 1, "", "get_preamble_content"], [1, 3, 1, "", "obs_to_dict"], [1, 3, 1, "", "plot"], [1, 3, 1, "", "read_preamble"], [1, 3, 1, "", "to_dart"], [1, 3, 1, "", "to_pandas"]], "dartwrf.obsseq_to_netcdf": [[1, 1, 1, "", "listdir_dirs"]], "dartwrf.old_functions": [[1, 1, 1, "", "create_obsseq_in_separate_obs"], [1, 1, 1, "", "obs_operator_nature"], [1, 1, 1, "", "read_prior_obs"], [1, 1, 1, "", "read_truth_obs_obsseq"], [1, 1, 1, "", "recycle_output"], [1, 1, 1, "", "replace_errors_obsseqout"], [1, 1, 1, "", "run_Hx"]], "dartwrf.prep_IC_prior": [[1, 1, 1, "", "create_updated_wrfinput_from_wrfout"], [1, 1, 1, "", "create_wrfrst_in_WRF_rundir"]], "dartwrf.run_obs_diag": [[1, 1, 1, "", "prepare"], [1, 1, 1, "", "run_obs_seq_to_netcdf"], [1, 1, 1, "", "run_obsdiag"], [1, 1, 1, "", "write_input_filelist"]], "dartwrf.update_IC": [[1, 1, 1, "", "update_initials_in_WRF_rundir"]], "dartwrf.utils": [[1, 2, 1, "", "ClusterConfig"], [1, 2, 1, "", "ExperimentConfiguration"], [1, 2, 1, "", "Shellslurm"], [1, 1, 1, "", "append_file"], [1, 1, 1, "", "clean_wrfdir"], [1, 1, 1, "", "copy"], [1, 1, 1, "", "copy_contents"], [1, 1, 1, "", "copy_scp_srvx8"], [1, 1, 1, "", "link_contents"], [1, 1, 1, "", "mkdir"], [1, 1, 1, "", "print"], [1, 1, 1, "", "script_to_str"], [1, 1, 1, "", "sed_inplace"], [1, 1, 1, "", "shell"], [1, 1, 1, "", "symlink"], [1, 1, 1, "", "try_remove"]], "dartwrf.utils.ClusterConfig": [[1, 4, 1, "", "archivedir"], [1, 3, 1, "", "backup_scripts"], [1, 3, 1, "", "create_job"], [1, 4, 1, "", "dartrundir"], [1, 4, 1, "", "scripts_rundir"], [1, 3, 1, "", "setup"], [1, 3, 1, "", "wrf_rundir"]], "dartwrf.utils.Shellslurm": [[1, 3, 1, "", "run"]], "dartwrf.wrfinput_add_geo": [[1, 1, 1, "", "run"]], "dartwrf.wrfout_add_geo": [[1, 1, 1, "", "run"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:method", "4": "py:property"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"], "4": ["py", "property", "Python property"]}, "titleterms": {"dartwrf": [1, 2, 4, 6], "packag": [1, 2], "subpackag": 1, "submodul": [1, 2], "assim_synth_ob": 1, "modul": [1, 2], "cleanup_exp": 1, "create_obs_upfront": 1, "create_obsseq": 1, "create_wbubble_wrfinput": 1, "evaluate_posterior": 1, "evaluate_prior": 1, "link_dart_rttov": 1, "obsseq": 1, "obsseq_2dim": 1, "obsseq_to_netcdf": 1, "old_funct": 1, "prep_ic_prior": 1, "prepare_namelist": 1, "prepare_wrfrundir": 1, "run_obs_diag": 1, "update_": 1, "util": 1, "wrfinput_add_geo": 1, "wrfout_add_geo": 1, "content": [1, 2], "ob": 2, "calculate_obs_loc": 2, "error_model": 2, "workflow": 3, "welcom": 5, "dart": 5, "wrf": 5, "document": 5, "indic": 5, "tabl": 5}, "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 package": [[1, "dartwrf-package"]], "Subpackages": [[1, "subpackages"]], "Submodules": [[1, "submodules"], [2, "submodules"]], "dartwrf.assim_synth_obs module": [[1, "dartwrf-assim-synth-obs-module"]], "dartwrf.cleanup_exp module": [[1, "dartwrf-cleanup-exp-module"]], "dartwrf.create_obs_upfront module": [[1, "dartwrf-create-obs-upfront-module"]], "dartwrf.create_obsseq module": [[1, "dartwrf-create-obsseq-module"]], "dartwrf.create_wbubble_wrfinput module": [[1, "dartwrf-create-wbubble-wrfinput-module"]], "dartwrf.evaluate_posterior module": [[1, "dartwrf-evaluate-posterior-module"]], "dartwrf.evaluate_prior module": [[1, "dartwrf-evaluate-prior-module"]], "dartwrf.link_dart_rttov module": [[1, "dartwrf-link-dart-rttov-module"]], "dartwrf.obsseq module": [[1, "module-dartwrf.obsseq"]], "dartwrf.obsseq_2dim module": [[1, "dartwrf-obsseq-2dim-module"]], "dartwrf.obsseq_to_netcdf module": [[1, "module-dartwrf.obsseq_to_netcdf"]], "dartwrf.old_functions module": [[1, "module-dartwrf.old_functions"]], "dartwrf.prep_IC_prior module": [[1, "module-dartwrf.prep_IC_prior"]], "dartwrf.prepare_namelist module": [[1, "dartwrf-prepare-namelist-module"]], "dartwrf.prepare_wrfrundir module": [[1, "dartwrf-prepare-wrfrundir-module"]], "dartwrf.run_obs_diag module": [[1, "module-dartwrf.run_obs_diag"]], "dartwrf.update_IC module": [[1, "module-dartwrf.update_IC"]], "dartwrf.utils module": [[1, "module-dartwrf.utils"]], "dartwrf.wrfinput_add_geo module": [[1, "module-dartwrf.wrfinput_add_geo"]], "dartwrf.wrfout_add_geo module": [[1, "module-dartwrf.wrfout_add_geo"]], "Module contents": [[1, "module-dartwrf"], [2, "module-dartwrf.obs"]], "dartwrf.obs package": [[2, "dartwrf-obs-package"]], "dartwrf.obs.calculate_obs_locations module": [[2, "module-dartwrf.obs.calculate_obs_locations"]], "dartwrf.obs.error_models module": [[2, "module-dartwrf.obs.error_models"]], "Workflow": [[3, "workflow"]], "dartwrf": [[4, "module-dartwrf"], [6, "dartwrf"]], "Welcome to the DART-WRF documentation!": [[5, "welcome-to-the-dart-wrf-documentation"]], "Indices and tables": [[5, "indices-and-tables"]]}, "indexentries": {"clusterconfig (class in dartwrf.utils)": [[1, "dartwrf.utils.ClusterConfig"]], "experimentconfiguration (class in dartwrf.utils)": [[1, "dartwrf.utils.ExperimentConfiguration"]], "obsrecord (class in dartwrf.obsseq)": [[1, "dartwrf.obsseq.ObsRecord"]], "obsseq (class in dartwrf.obsseq)": [[1, "dartwrf.obsseq.ObsSeq"]], "shellslurm (class in dartwrf.utils)": [[1, "dartwrf.utils.Shellslurm"]], "append_file() (in module dartwrf.utils)": [[1, "dartwrf.utils.append_file"]], "archivedir (dartwrf.utils.clusterconfig property)": [[1, "dartwrf.utils.ClusterConfig.archivedir"]], "backup_scripts() (dartwrf.utils.clusterconfig method)": [[1, "dartwrf.utils.ClusterConfig.backup_scripts"]], "clean_wrfdir() (in module dartwrf.utils)": [[1, "dartwrf.utils.clean_wrfdir"]], "copy() (in module dartwrf.utils)": [[1, "dartwrf.utils.copy"]], "copy_contents() (in module dartwrf.utils)": [[1, "dartwrf.utils.copy_contents"]], "copy_scp_srvx8() (in module dartwrf.utils)": [[1, "dartwrf.utils.copy_scp_srvx8"]], "create_job() (dartwrf.utils.clusterconfig method)": [[1, "dartwrf.utils.ClusterConfig.create_job"]], "create_obsseq_in_separate_obs() (in module dartwrf.old_functions)": [[1, "dartwrf.old_functions.create_obsseq_in_separate_obs"]], "create_updated_wrfinput_from_wrfout() (in module dartwrf.prep_ic_prior)": [[1, "dartwrf.prep_IC_prior.create_updated_wrfinput_from_wrfout"]], "create_wrfrst_in_wrf_rundir() (in module dartwrf.prep_ic_prior)": [[1, "dartwrf.prep_IC_prior.create_wrfrst_in_WRF_rundir"]], "dartrundir (dartwrf.utils.clusterconfig property)": [[1, "dartwrf.utils.ClusterConfig.dartrundir"]], "dartwrf": [[1, "module-dartwrf"], [4, "module-dartwrf"]], "dartwrf.obsseq": [[1, "module-dartwrf.obsseq"]], "dartwrf.obsseq_to_netcdf": [[1, "module-dartwrf.obsseq_to_netcdf"]], "dartwrf.old_functions": [[1, "module-dartwrf.old_functions"]], "dartwrf.prep_ic_prior": [[1, "module-dartwrf.prep_IC_prior"]], "dartwrf.run_obs_diag": [[1, "module-dartwrf.run_obs_diag"]], "dartwrf.update_ic": [[1, "module-dartwrf.update_IC"]], "dartwrf.utils": [[1, "module-dartwrf.utils"]], "dartwrf.wrfinput_add_geo": [[1, "module-dartwrf.wrfinput_add_geo"]], "dartwrf.wrfout_add_geo": [[1, "module-dartwrf.wrfout_add_geo"]], "degrees_to_rad() (in module dartwrf.obsseq)": [[1, "dartwrf.obsseq.degrees_to_rad"]], "determine_nlayers() (dartwrf.obsseq.obsrecord method)": [[1, "dartwrf.obsseq.ObsRecord.determine_nlayers"]], "get_from_cartesian_grid() (dartwrf.obsseq.obsrecord method)": [[1, "dartwrf.obsseq.ObsRecord.get_from_cartesian_grid"]], "get_lon_lat() (dartwrf.obsseq.obsrecord method)": [[1, "dartwrf.obsseq.ObsRecord.get_lon_lat"]], "get_posterior_hx() (dartwrf.obsseq.obsrecord method)": [[1, "dartwrf.obsseq.ObsRecord.get_posterior_Hx"]], "get_preamble_content() (dartwrf.obsseq.obsseq method)": [[1, "dartwrf.obsseq.ObsSeq.get_preamble_content"]], "get_prior_hx() (dartwrf.obsseq.obsrecord method)": [[1, "dartwrf.obsseq.ObsRecord.get_prior_Hx"]], "get_truth_hx() (dartwrf.obsseq.obsrecord method)": [[1, "dartwrf.obsseq.ObsRecord.get_truth_Hx"]], "link_contents() (in module dartwrf.utils)": [[1, "dartwrf.utils.link_contents"]], "listdir_dirs() (in module dartwrf.obsseq_to_netcdf)": [[1, "dartwrf.obsseq_to_netcdf.listdir_dirs"]], "mkdir() (in module dartwrf.utils)": [[1, "dartwrf.utils.mkdir"]], "module": [[1, "module-dartwrf"], [1, "module-dartwrf.obsseq"], [1, "module-dartwrf.obsseq_to_netcdf"], [1, "module-dartwrf.old_functions"], [1, "module-dartwrf.prep_IC_prior"], [1, "module-dartwrf.run_obs_diag"], [1, "module-dartwrf.update_IC"], [1, "module-dartwrf.utils"], [1, "module-dartwrf.wrfinput_add_geo"], [1, "module-dartwrf.wrfout_add_geo"], [2, "module-dartwrf.obs"], [2, "module-dartwrf.obs.calculate_obs_locations"], [2, "module-dartwrf.obs.error_models"], [4, "module-dartwrf"]], "obs_operator_nature() (in module dartwrf.old_functions)": [[1, "dartwrf.old_functions.obs_operator_nature"]], "obs_to_dict() (dartwrf.obsseq.obsseq method)": [[1, "dartwrf.obsseq.ObsSeq.obs_to_dict"]], "plot() (dartwrf.obsseq.obsseq method)": [[1, "dartwrf.obsseq.ObsSeq.plot"]], "plot_box() (in module dartwrf.obsseq)": [[1, "dartwrf.obsseq.plot_box"]], "prepare() (in module dartwrf.run_obs_diag)": [[1, "dartwrf.run_obs_diag.prepare"]], "print() (in module dartwrf.utils)": [[1, "dartwrf.utils.print"]], "rad_to_degrees() (in module dartwrf.obsseq)": [[1, "dartwrf.obsseq.rad_to_degrees"]], "read_preamble() (dartwrf.obsseq.obsseq method)": [[1, "dartwrf.obsseq.ObsSeq.read_preamble"]], "read_prior_obs() (in module dartwrf.old_functions)": [[1, "dartwrf.old_functions.read_prior_obs"]], "read_truth_obs_obsseq() (in module dartwrf.old_functions)": [[1, "dartwrf.old_functions.read_truth_obs_obsseq"]], "recycle_output() (in module dartwrf.old_functions)": [[1, "dartwrf.old_functions.recycle_output"]], "replace_errors_obsseqout() (in module dartwrf.old_functions)": [[1, "dartwrf.old_functions.replace_errors_obsseqout"]], "run() (dartwrf.utils.shellslurm method)": [[1, "dartwrf.utils.Shellslurm.run"]], "run() (in module dartwrf.wrfinput_add_geo)": [[1, "dartwrf.wrfinput_add_geo.run"]], "run() (in module dartwrf.wrfout_add_geo)": [[1, "dartwrf.wrfout_add_geo.run"]], "run_hx() (in module dartwrf.old_functions)": [[1, "dartwrf.old_functions.run_Hx"]], "run_obs_seq_to_netcdf() (in module dartwrf.run_obs_diag)": [[1, "dartwrf.run_obs_diag.run_obs_seq_to_netcdf"]], "run_obsdiag() (in module dartwrf.run_obs_diag)": [[1, "dartwrf.run_obs_diag.run_obsdiag"]], "script_to_str() (in module dartwrf.utils)": [[1, "dartwrf.utils.script_to_str"]], "scripts_rundir (dartwrf.utils.clusterconfig property)": [[1, "dartwrf.utils.ClusterConfig.scripts_rundir"]], "sed_inplace() (in module dartwrf.utils)": [[1, "dartwrf.utils.sed_inplace"]], "setup() (dartwrf.utils.clusterconfig method)": [[1, "dartwrf.utils.ClusterConfig.setup"]], "shell() (in module dartwrf.utils)": [[1, "dartwrf.utils.shell"]], "superob() (dartwrf.obsseq.obsrecord method)": [[1, "dartwrf.obsseq.ObsRecord.superob"]], "symlink() (in module dartwrf.utils)": [[1, "dartwrf.utils.symlink"]], "to_dart() (dartwrf.obsseq.obsseq method)": [[1, "dartwrf.obsseq.ObsSeq.to_dart"]], "to_pandas() (dartwrf.obsseq.obsseq method)": [[1, "dartwrf.obsseq.ObsSeq.to_pandas"]], "try_remove() (in module dartwrf.utils)": [[1, "dartwrf.utils.try_remove"]], "update_initials_in_wrf_rundir() (in module dartwrf.update_ic)": [[1, "dartwrf.update_IC.update_initials_in_WRF_rundir"]], "wrf_rundir() (dartwrf.utils.clusterconfig method)": [[1, "dartwrf.utils.ClusterConfig.wrf_rundir"]], "write_input_filelist() (in module dartwrf.run_obs_diag)": [[1, "dartwrf.run_obs_diag.write_input_filelist"]], "oe_model_harnisch_wv62() (in module dartwrf.obs.error_models)": [[2, "dartwrf.obs.error_models.OE_model_harnisch_WV62"]], "oe_model_harnisch_wv73() (in module dartwrf.obs.error_models)": [[2, "dartwrf.obs.error_models.OE_model_harnisch_WV73"]], "calc_obserr_wv() (in module dartwrf.obs.error_models)": [[2, "dartwrf.obs.error_models.calc_obserr_WV"]], "cloudimpact() (in module dartwrf.obs.error_models)": [[2, "dartwrf.obs.error_models.cloudimpact"]], "dartwrf.obs": [[2, "module-dartwrf.obs"]], "dartwrf.obs.calculate_obs_locations": [[2, "module-dartwrf.obs.calculate_obs_locations"]], "dartwrf.obs.error_models": [[2, "module-dartwrf.obs.error_models"]], "evenly_on_grid() (in module dartwrf.obs.calculate_obs_locations)": [[2, "dartwrf.obs.calculate_obs_locations.evenly_on_grid"]], "square_array_from_domaincenter() (in module dartwrf.obs.calculate_obs_locations)": [[2, "dartwrf.obs.calculate_obs_locations.square_array_from_domaincenter"]]}}) \ No newline at end of file diff --git a/docs/pyproject.toml b/docs/pyproject.toml new file mode 100644 index 0000000000000000000000000000000000000000..fbc33db517970cc0c5766217a8f94da4be16c889 --- /dev/null +++ b/docs/pyproject.toml @@ -0,0 +1,9 @@ +[build-system] +requires = ["flit_core >=3.2,<4"] +build-backend = "flit_core.buildapi" + +[project] +name = "dartwrf" +authors = [{name = "Lukas Kugler", email = "lukas.kugler@univie.ac.at"}] +dynamic = ["version", "description"] + diff --git a/docs/source/dartwrf.obs.rst b/docs/source/dartwrf.obs.rst new file mode 100644 index 0000000000000000000000000000000000000000..79a1e0e57472de8c7562aacda2720bb20ffb10f3 --- /dev/null +++ b/docs/source/dartwrf.obs.rst @@ -0,0 +1,29 @@ +dartwrf.obs package +=================== + +Submodules +---------- + +dartwrf.obs.calculate\_obs\_locations module +-------------------------------------------- + +.. automodule:: dartwrf.obs.calculate_obs_locations + :members: + :undoc-members: + :show-inheritance: + +dartwrf.obs.error\_models module +-------------------------------- + +.. automodule:: dartwrf.obs.error_models + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: dartwrf.obs + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/dartwrf.rst b/docs/source/dartwrf.rst new file mode 100644 index 0000000000000000000000000000000000000000..7353c0e5b69833543bf910bd45bda9b97f58c2c3 --- /dev/null +++ b/docs/source/dartwrf.rst @@ -0,0 +1,182 @@ +dartwrf package +=============== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + dartwrf.config + dartwrf.obs + +Submodules +---------- + +dartwrf.assim\_synth\_obs module +-------------------------------- + +.. automodule:: dartwrf.assim_synth_obs + :members: + :undoc-members: + :show-inheritance: + +dartwrf.cleanup\_exp module +--------------------------- + +.. automodule:: dartwrf.cleanup_exp + :members: + :undoc-members: + :show-inheritance: + +dartwrf.create\_obs\_upfront module +----------------------------------- + +.. automodule:: dartwrf.create_obs_upfront + :members: + :undoc-members: + :show-inheritance: + +dartwrf.create\_obsseq module +----------------------------- + +.. automodule:: dartwrf.create_obsseq + :members: + :undoc-members: + :show-inheritance: + +dartwrf.create\_wbubble\_wrfinput module +---------------------------------------- + +.. automodule:: dartwrf.create_wbubble_wrfinput + :members: + :undoc-members: + :show-inheritance: + +dartwrf.evaluate\_posterior module +---------------------------------- + +.. automodule:: dartwrf.evaluate_posterior + :members: + :undoc-members: + :show-inheritance: + +dartwrf.evaluate\_prior module +------------------------------ + +.. automodule:: dartwrf.evaluate_prior + :members: + :undoc-members: + :show-inheritance: + +dartwrf.link\_dart\_rttov module +-------------------------------- + +.. automodule:: dartwrf.link_dart_rttov + :members: + :undoc-members: + :show-inheritance: + +dartwrf.obsseq module +--------------------- + +.. automodule:: dartwrf.obsseq + :members: + :undoc-members: + :show-inheritance: + +dartwrf.obsseq\_2dim module +--------------------------- + +.. automodule:: dartwrf.obsseq_2dim + :members: + :undoc-members: + :show-inheritance: + +dartwrf.obsseq\_to\_netcdf module +--------------------------------- + +.. automodule:: dartwrf.obsseq_to_netcdf + :members: + :undoc-members: + :show-inheritance: + +dartwrf.old\_functions module +----------------------------- + +.. automodule:: dartwrf.old_functions + :members: + :undoc-members: + :show-inheritance: + +dartwrf.prep\_IC\_prior module +------------------------------ + +.. automodule:: dartwrf.prep_IC_prior + :members: + :undoc-members: + :show-inheritance: + +dartwrf.prepare\_namelist module +-------------------------------- + +.. automodule:: dartwrf.prepare_namelist + :members: + :undoc-members: + :show-inheritance: + +dartwrf.prepare\_wrfrundir module +--------------------------------- + +.. automodule:: dartwrf.prepare_wrfrundir + :members: + :undoc-members: + :show-inheritance: + +dartwrf.run\_obs\_diag module +----------------------------- + +.. automodule:: dartwrf.run_obs_diag + :members: + :undoc-members: + :show-inheritance: + +dartwrf.update\_IC module +------------------------- + +.. automodule:: dartwrf.update_IC + :members: + :undoc-members: + :show-inheritance: + +dartwrf.utils module +-------------------- + +.. automodule:: dartwrf.utils + :members: + :undoc-members: + :show-inheritance: + +dartwrf.wrfinput\_add\_geo module +--------------------------------- + +.. automodule:: dartwrf.wrfinput_add_geo + :members: + :undoc-members: + :show-inheritance: + +dartwrf.wrfout\_add\_geo module +------------------------------- + +.. automodule:: dartwrf.wrfout_add_geo + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: dartwrf + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/index.rst b/docs/source/index.rst index 3b23e27aadb68ffba9a22833a3fc5cd92f1deb04..7d932e88b9f1c2b6b4af1631e907d6f3b061f50d 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -5,12 +5,17 @@ DART-WRF is a Python package to run an Ensemble Data Assimilation system with th +.. toctree:: +:maxdepth: 2 +:caption: Contents: -Contents --------- -.. toctree:: - api - example +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 0000000000000000000000000000000000000000..d2417a80236590c7d565d3c2f36e15d0fa95cfdc --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,7 @@ +dartwrf +======= + +.. toctree:: + :maxdepth: 4 + + dartwrf