Skip to content
Snippets Groups Projects
Commit eac8310c authored by lkugler's avatar lkugler
Browse files

docs

parent 5b6b0e66
No related branches found
No related tags found
No related merge requests found
Showing
with 577 additions and 557 deletions
No preview for this file type
No preview for this file type
No preview for this file type
No preview for this file type
# 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
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).
......
......@@ -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
......@@ -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
<!DOCTYPE html>
<html lang="en">
<html class="writer-html5" 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/" />
<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>&lt;no title&gt; &mdash; 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]-->
<title>&lt;no title&gt; &#8212; 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 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" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
</div>
</div>
<link rel="next" title="dartwrf" href="generated/dartwrf.html" />
<link rel="prev" title="Welcome to the DART-WRF documentation!" href="index.html" />
</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" >
<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 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>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li><a href="index2.html">Documentation overview</a><ul>
</ul></li>
<li class="toctree-l1"><a class="reference internal" href="generated/dartwrf.html">dartwrf</a></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>
</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">&lt;no title&gt;</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/api.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<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>
<div class="clearer"></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 class="footer">
&copy;2023, Lukas Kugler.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 6.1.3</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
<hr/>
|
<a href="_sources/api.rst.txt"
rel="nofollow">Page source</a>
<div role="contentinfo">
<p>&#169; 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>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
\ No newline at end of file
<!DOCTYPE html>
<html lang="en">
<html class="writer-html5" 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/" />
<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 &mdash; 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]-->
<title>&lt;no title&gt; &#8212; 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 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="prev" title="dartwrf" href="generated/dartwrf.html" />
</head>
<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" />
<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="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">
</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">
<p>## Workflow
#### Configure your experiment
<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>
<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 class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index2.html">DART-WRF</a></h1>
<hr/>
<h3>Navigation</h3>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index2.html">Documentation overview</a><ul>
</ul></li>
</ul>
<div role="contentinfo">
<p>&#169; Copyright 2023, Lukas Kugler.</p>
</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>
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>
</section>
</div>
<div class="footer">
&copy;2023, Lukas Kugler.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 6.1.3</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
|
<a href="_sources/example.rst.txt"
rel="nofollow">Page source</a>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
\ No newline at end of file
<!DOCTYPE html>
<html lang="en">
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &#8212; 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" />
<title>Index &mdash; 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="#" />
<link rel="search" title="Search" href="search.html" />
</head>
<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">
<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" >
<h1 id="index">Index</h1>
<div class="genindex-jumpbox">
<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>
</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 class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index2.html">DART-WRF</a></h1>
<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>
<h3>Navigation</h3>
</div>
<h2 id="D">D</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
dartwrf
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index2.html">Documentation overview</a><ul>
<li><a href="generated/dartwrf.html#module-dartwrf">module</a>
</li>
</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>
</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 class="clearer"></div>
</div>
<div class="footer">
&copy;2023, Lukas Kugler.
<footer>
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 6.1.3</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
<hr/>
<div role="contentinfo">
<p>&#169; 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>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
\ No newline at end of file
<!DOCTYPE html>
<html lang="en">
<html class="writer-html5" 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/" />
<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! &mdash; 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]-->
<title>Welcome to the DART-WRF documentation! &#8212; 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 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="next" title="&lt;no title&gt;" href="api.html" />
</head>
<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>
<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>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="api.html" class="btn btn-neutral float-right" title="&lt;no title&gt;" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index2.html">DART-WRF</a></h1>
<hr/>
<h3>Navigation</h3>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index2.html">Documentation overview</a><ul>
</ul></li>
</ul>
<div role="contentinfo">
<p>&#169; Copyright 2023, Lukas Kugler.</p>
</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>
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">
&copy;2023, Lukas Kugler.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 6.1.3</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
|
<a href="_sources/index.rst.txt"
rel="nofollow">Page source</a>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
\ No newline at end of file
No preview for this file type
<!DOCTYPE html>
<html lang="en">
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Search &#8212; 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" />
<title>Search &mdash; 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>
<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" />
</head>
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
<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>
<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="document">
<div class="documentwrapper">
<div class="bodywrapper">
<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.
<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 class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index2.html">DART-WRF</a></h1>
<footer>
<h3>Navigation</h3>
<hr/>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index2.html">Documentation overview</a><ul>
</ul></li>
</ul>
<div role="contentinfo">
<p>&#169; 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>
</section>
</div>
<div class="footer">
&copy;2023, Lukas Kugler.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 6.1.3</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<script>
jQuery(function() { Search.loadIndex("searchindex.js"); });
</script>
<script id="searchindexloader"></script>
......
Search.setIndex({"docnames": ["api", "example", "index", "index2"], "filenames": ["api.rst", "example.rst", "index.rst", "index2.rst"], "titles": ["&lt;no title&gt;", "&lt;no title&gt;", "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": ["&lt;no title&gt;", "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
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 = {
......
# 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'
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).
......
dartwrf
=======
.. automodule:: dartwrf
......@@ -11,7 +11,6 @@ Contents
.. toctree::
usage
api
docs/source/example
example
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment