Skip to content
Snippets Groups Projects
Commit 42bc15f6 authored by anphi's avatar anphi
Browse files

merge branch ctbto to master

parents 037f7bba 903ed4fd
No related branches found
No related tags found
No related merge requests found
Showing
with 9194 additions and 0 deletions
#!/bin/bash
#
# @Author: Anne Philipp
#
# @Date: January 2018
#
# @Description:
# gitignore lists all directories and files which should
# not be versionized!!!
#
# @Licence:
# (C) Copyright 2014-2020.
#
# SPDX-License-Identifier: CC-BY-4.0
#
# This work is licensed under the Creative Commons Attribution 4.0
# International License. To view a copy of this license, visit
# http://creativecommons.org/licenses/by/4.0/ or send a letter to
# Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
#
# -----------------------------------------------------------------
# these dirs and files shouldn't be versionized at any time in this project!!!
*.pyc
Source/Fortran/*.o
Source/Fortran/*.mod
Source/Fortran/calc_etadot*
*.tar*
Run/ECMWF_ENV
Run/Workspace/*
Run/Jobscripts/*sh
Testing/Installation/Calc_etadot/fort.15
For_developers/Sphinx/Build_temp
# Temporary ignorance of files!!!!
*anne.sh
Run/*anne.sh
Source/Fortran/pycallgraph.png
Source/Python/pylint_report_7.1.txt
Source/.metrics
# Testdata files: not for git storage
Testdata
Testing/Installation/Calc_etadot/VERTICAL.EC
Testing/Regression/Compare_gribfiles/7.0.4/
Testing/Regression/Compare_gribfiles/7.1/
Emoslib
Unused_input_files
Unused_output
# Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment
include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at fp-dev(at)lists.univie.ac.at. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
\ No newline at end of file
# 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: cac76732818e0e42f835f525375110ca
tags: 645f666f9bcd5a90fca523b33c5a78b7
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Updating the documentation &mdash; flex_extract 7.1.2 documentation</title>
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme_overrides.css" type="text/css" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Changelog" href="../changelog.html" />
<link rel="prev" title="Developer Guide" href="../dev_guide.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"> flex_extract
</a>
<div class="version">
7.1.2
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="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="main navigation">
<p class="caption"><span class="caption-text">Table of Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../ecmwf_data.html">ECMWF Data</a></li>
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quick_start.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="../documentation.html">Code-Level Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../evaluation.html">Evaluation</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../dev_guide.html">Developer Guide</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">Updating the documentation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#additional-software">Additional software</a></li>
<li class="toctree-l3"><a class="reference internal" href="#on-line-documentation-with-sphinx">On-line documentation with Sphinx</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#sequence-diagramms">Sequence diagramms</a></li>
<li class="toctree-l4"><a class="reference internal" href="#block-diagramms">Block diagramms</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="../support.html">Support</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Support/faq.html">FAQ - Frequently asked questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../authors.html">Developer Team</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">flex_extract</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html">Docs</a> &raquo;</li>
<li><a href="../dev_guide.html">Developer Guide</a> &raquo;</li>
<li>Updating the documentation</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/Developers/gen_docu.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">
<div class="section" id="updating-the-documentation">
<h1>Updating the documentation<a class="headerlink" href="#updating-the-documentation" title="Permalink to this headline"></a></h1>
<p>UNDER CONSTRUCTION</p>
<div class="section" id="additional-software">
<h2>Additional software<a class="headerlink" href="#additional-software" title="Permalink to this headline"></a></h2>
<p>Developers working on <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code> should make extensive use of the prepared test cases and unit tests, and should also update the documentation. For this, some additional software is necessary:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pip install pylint
pip install pytest
pip install mock
pip install graphviz
pip install sphinx
pip install sphinxcontrib-exceltable
pip install seqdiag
pip install sphinxcontrib-seqdiag
pip install sphinxcontrib-blockdiag
pip install pycallgraph
</pre></div>
</div>
</div>
<div class="section" id="on-line-documentation-with-sphinx">
<h2>On-line documentation with Sphinx<a class="headerlink" href="#on-line-documentation-with-sphinx" title="Permalink to this headline"></a></h2>
<p>Use the script <code class="docutils literal notranslate"><span class="pre">gen_docu.sh</span></code> to generate an update of the on-line documentation of the Python component.</p>
<p>It uses <code class="docutils literal notranslate"><span class="pre">pyreverse</span></code> to generate class and package diagrams with <code class="docutils literal notranslate"><span class="pre">graphviz</span></code> and overwrites the old files in the developers directory.
<code class="docutils literal notranslate"><span class="pre">pyreverse</span></code> creates <code class="docutils literal notranslate"><span class="pre">dot</span></code> files, and with the <code class="docutils literal notranslate"><span class="pre">dot</span></code> program of the <code class="docutils literal notranslate"><span class="pre">graphviz</span></code> software, the <code class="docutils literal notranslate"><span class="pre">png</span></code> files are created. Everything happens in the Python source directory before moving them finally to the <code class="docutils literal notranslate"><span class="pre">For_developers</span></code> directory. The Sphinx source code has a <code class="docutils literal notranslate"><span class="pre">_files</span></code> directory which contains links to these <code class="docutils literal notranslate"><span class="pre">png</span></code> files and therefore they should not be renamed.</p>
<div class="section" id="sequence-diagramms">
<h3>Sequence diagramms<a class="headerlink" href="#sequence-diagramms" title="Permalink to this headline"></a></h3>
<p>You might need to adapt the fonts path for the diagrams to a true-type font. Currently it is set to:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># Fontpath for seqdiag (truetype font)</span>
<span class="nv">seqdiag_fontpath</span> <span class="o">=</span> <span class="s1">&#39;/usr/share/fonts/dejavu/DejaVuSerif.ttf&#39;</span>
</pre></div>
</div>
</div>
<div class="section" id="block-diagramms">
<h3>Block diagramms<a class="headerlink" href="#block-diagramms" title="Permalink to this headline"></a></h3>
<p>You might need to adapt the fonts path for the diagrams to a true-type font. Currently it is set to:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># Fontpath for blockdiag (truetype font)</span>
<span class="nv">blockdiag_fontpath</span> <span class="o">=</span> <span class="s1">&#39;/usr/share/fonts/dejavu/DejaVuSerif.ttf&#39;</span>
</pre></div>
</div>
<div class="toctree-wrapper compound">
</div>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../changelog.html" class="btn btn-neutral float-right" title="Changelog" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../dev_guide.html" class="btn btn-neutral float-left" title="Developer Guide" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2020, Anne Philipp, Leopold Haimberger and Petra Seibert
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
\ No newline at end of file
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
body {
padding-top: 70px;
}
table.nostretch {
width=100%
}
.nostretch td {
class='block'
}
.nostretch tr td{
width:1%;
white-space:nowrap;
}
:target:before {
content:"";
display:block;
height:60px;
margin:-60px 0 0;
}
ol.hierarchy {
min-height: 40px;
background-color: #f5f5f5;
border: 1px solid #e3e3e3;
border-radius: 3px;
-webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.05);
box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.05);
}
.smallcaps {
font-variant: small-caps;
}
.well .sidebar {
padding: 8px 0
}
.sidebar a {
padding: 0px,0px,0px,0px
}
.varlist>tbody>tr>td {
padding-left: 3px;
padding-right: 3px;
}
.varlist>tbody>tr>td:first-child, .varlist>thead>tr>td:first-child {
padding-left: 8px;
}
.varlist>tbody>td>td:last-child, .varlist>thead>tr>td:last-child {
padding-right: 8px;
}
.highlight pre {
overflow-x: auto;
overflow-wrap: normal;
white-space: pre
}
/* .hl is for when line numbers are included, .highlight is for all
other cases. */
.hl pre {
counter-reset: line-numbering;
overflow-x: auto;
overflow-wrap: normal;
white-space: pre;
padding: 0;
padding-right: 9.5px;
overflow-y: hidden;
padding-bottom: 9.5px;
}
.hl pre a::before {
content: counter(line-numbering);
counter-increment: line-numbering;
padding-right: 0.7em; /* space after numbers */
margin-top: 4.5em;
width: 60px;
text-align: right;
opacity: 0.7;
display: inline-block;
color: #aaa;
background: #eee;
margin-right: 10px;
border-right: 1px solid #ccc;
-webkit-touch-callout: none;
-webkit-user-select: none;
-khtml-user-select: none;
-moz-user-select: none;
-ms-user-select: none;
user-select: none;
}
.hl pre a:first-of-type::before {
padding-top: 9.5px;
}
.hl pre a:last-of-type::before {
padding-bottom: 9.5px;
}
.hl pre a:only-of-type::before {
padding: 9.5px;
}
.hl pre a {
display: inline-block;
height: 4.5em;
margin: -4.5em 0 0;
}
.codesum h3 {
margin-top: 2px;
margin-bottom: 2px;
}
h1.inline, h2.inline, h3.inline {
display: inline;
}
.depwarn {
float: right;
}
.anchor {
position: absolute;
margin: -4.5em;
visibility:hidden;
}
.alert {
margin-left: 5px;
margin-right: 5px;
margin-top: 5px;
}
div.toc {
font-size: 14.73px;
padding-left: 0px;
padding-right: 0px;
}
div.toc a {
padding-left: 20px;
padding-right: 20px;
margin-right: 15px;
padding-top: 5px;
padding-bottom: 5px;
}
div.toc li {
font-size: 0.95em;
padding-left: 15px;
}
div.toc li.title {
font-size: 1em;
}
div.toc hr {
margin-top: 12px;
margin-bottom: 10px;
}
.in-well {
padding: 0px 0px;
margin-bottom: 0px;
float:right;
}
table tr.submod>td {
border-top: none;
font-size: 13.5px;
}
.graph-help {
font-size: 10px;
}
.depgraph {
width: 100%;
max-width: 1140px;
}
#sidebar a {
white-space: nowrap;
overflow: hidden;
text-overflow: ellipsis;
}
.highlighttable {
width: auto;
table-layout: fixed;
}
ul.checklist {
list-style-type: none;
}
ul.checklist input[type="checkbox"] {
margin-left: -20.8px;
margin-right: 4.55px;
}
.gitter-chat-embed {
z-index: 100000;
}
table.graph {
text-align: center;
}
.graph td.root {
border:2px solid black;
padding:10px;
}
.graph td.triangle-right:after {
content: "";
display: block;
border-top: 7px solid transparent;
border-bottom: 7px solid transparent;
border-left: 7px solid black;
}
.graph td.triangle-left:after {
content: "";
display: block;
border-top: 7px solid transparent;
border-bottom: 7px solid transparent;
border-right: 7px solid black;
}
.graph td.node {
color: white;
padding:10px;
border-style: solid;
border-width: 3px 0px 3px 0px;
border-color: white;
}
.graph td.node a{
color: white;
}
.graph td.dashedText,
.graph td.solidText {
padding: 0px 10px 0px 10px;
min-width: 40px;
color: black;
border-color: black;
}
.graph td.dashedText {
border-bottom-style: dashed;
}
.graph td.solidText {
border-bottom-style: solid;
}
.graph td.dashedBottom,
.graph td.dashedTop,
.graph td.solidTop,
.graph td.solidBottom {
min-width: 40px;
color: transparent;
border-color: black;
}
.graph td.dashedBottom {
border-bottom-style: dashed;
}
.graph td.dashedTop {
border-top-style: dashed;
}
.graph td.solidBottom {
border-bottom-style: solid;
}
.graph td.solidTop {
border-top-style: solid;
}
pre .hll { background-color: #ffffcc }
pre .c { color: #408080; font-style: italic } /* Comment */
pre .err { border: 1px solid #FF0000 } /* Error */
pre .k { color: #008000; font-weight: bold } /* Keyword */
pre .o { color: #666666 } /* Operator */
pre .cm { color: #408080; font-style: italic } /* Comment.Multiline */
pre .cp { color: #BC7A00 } /* Comment.Preproc */
pre .c1 { color: #408080; font-style: italic } /* Comment.Single */
pre .cs { color: #408080; font-style: italic } /* Comment.Special */
pre .gd { color: #A00000 } /* Generic.Deleted */
pre .ge { font-style: italic } /* Generic.Emph */
pre .gr { color: #FF0000 } /* Generic.Error */
pre .gh { color: #000080; font-weight: bold } /* Generic.Heading */
pre .gi { color: #00A000 } /* Generic.Inserted */
pre .go { color: #888888 } /* Generic.Output */
pre .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
pre .gs { font-weight: bold } /* Generic.Strong */
pre .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
pre .gt { color: #0044DD } /* Generic.Traceback */
pre .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
pre .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
pre .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
pre .kp { color: #008000 } /* Keyword.Pseudo */
pre .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
pre .kt { color: #B00040 } /* Keyword.Type */
pre .m { color: #666666 } /* Literal.Number */
pre .s { color: #BA2121 } /* Literal.String */
pre .na { color: #7D9029 } /* Name.Attribute */
pre .nb { color: #008000 } /* Name.Builtin */
pre .nc { color: #0000FF; font-weight: bold } /* Name.Class */
pre .no { color: #880000 } /* Name.Constant */
pre .nd { color: #AA22FF } /* Name.Decorator */
pre .ni { color: #999999; font-weight: bold } /* Name.Entity */
pre .ne { color: #D2413A; font-weight: bold } /* Name.Exception */
pre .nf { color: #0000FF } /* Name.Function */
pre .nl { color: #A0A000 } /* Name.Label */
pre .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
pre .nt { color: #008000; font-weight: bold } /* Name.Tag */
pre .nv { color: #19177C } /* Name.Variable */
pre .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
pre .w { color: #bbbbbb } /* Text.Whitespace */
pre .mf { color: #666666 } /* Literal.Number.Float */
pre .mh { color: #666666 } /* Literal.Number.Hex */
pre .mi { color: #666666 } /* Literal.Number.Integer */
pre .mo { color: #666666 } /* Literal.Number.Oct */
pre .sb { color: #BA2121 } /* Literal.String.Backtick */
pre .sc { color: #BA2121 } /* Literal.String.Char */
pre .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
pre .s2 { color: #BA2121 } /* Literal.String.Double */
pre .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */
pre .sh { color: #BA2121 } /* Literal.String.Heredoc */
pre .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */
pre .sx { color: #008000 } /* Literal.String.Other */
pre .sr { color: #BB6688 } /* Literal.String.Regex */
pre .s1 { color: #BA2121 } /* Literal.String.Single */
pre .ss { color: #19177C } /* Literal.String.Symbol */
pre .bp { color: #008000 } /* Name.Builtin.Pseudo */
pre .vc { color: #19177C } /* Name.Variable.Class */
pre .vg { color: #19177C } /* Name.Variable.Global */
pre .vi { color: #19177C } /* Name.Variable.Instance */
pre .il { color: #666666 } /* Literal.Number.Integer.Long */
Documentation/html/Documentation/Api/Fortran/favicon.png

1.63 KiB

File added
Source diff could not be displayed: it is too large. Options to address this: view the blob.
File added
File added
File added
File added
File added
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment