Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/sunt05/UMEP-Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sunt05 committed May 14, 2018
2 parents f3dee50 + 863a57a commit aed210c
Show file tree
Hide file tree
Showing 119 changed files with 3,865 additions and 2,290 deletions.
Binary file modified docs/build/doctrees/Abbreviations.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/FAQ.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/Getting_Started.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/How_to_Contribute.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/Introduction.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/Known_Issues.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/People_Involved_&_Acknowledgements.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/Tutorials/Footprint.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/Tutorials/GQF.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/Tutorials/IntroductionToSolweig.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/Tutorials/IntroductionToSuews.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/Tutorials/LQF.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/Tutorials/SEBE.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/doctrees/Tutorials/Tutorials.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/doctrees/index.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/post_processor/Benchmark System.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/doctrees/post_processor/Post-Processor.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/doctrees/pre-processor/Pre-Processor.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/pre-processor/SUEWS Prepare.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/doctrees/processor/Processor.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/doctrees/processor/Urban Energy Balance GQ.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/processor/Urban Energy Balance LQ.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: d826037456369ee884f27776284ddfd4
config: f7fd7c5c25a7fddb7d7f8cabe8e622ab
tags: 645f666f9bcd5a90fca523b33c5a78b7
41 changes: 16 additions & 25 deletions docs/build/html/Abbreviations.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,27 +25,19 @@




<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />



<link rel="stylesheet" href="_static/theme_overrides.css" type="text/css" />



<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="UMEP Manual documentation" href="index.html"/>
<link rel="prev" title="10. FAQ (Frequently Asked Questions)" href="FAQ.html"/>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/theme_overrides.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="10. FAQ (Frequently Asked Questions)" href="FAQ.html" />


<script src="_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">
<body class="wy-body-for-nav">


<div class="wy-grid-for-nav">
Expand Down Expand Up @@ -110,17 +102,18 @@
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">


<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<nav class="wy-nav-top" aria-label="top navigation">

<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">UMEP Manual</a>

</nav>



<div class="wy-nav-content">

<div class="rst-content">




Expand Down Expand Up @@ -300,9 +293,7 @@


</div>
<div class="articleComments">

</div>

</div>
<footer>

Expand All @@ -322,7 +313,7 @@

</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
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>

Expand All @@ -341,6 +332,7 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
Expand All @@ -358,14 +350,13 @@
<script type="text/javascript" src="_static/js/theme.js"></script>




<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();

SphinxRtdTheme.Navigation.enableSticky();

});
</script>

</script>

</body>
</html>
43 changes: 17 additions & 26 deletions docs/build/html/FAQ.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,28 +25,20 @@




<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />



<link rel="stylesheet" href="_static/theme_overrides.css" type="text/css" />



<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="UMEP Manual documentation" href="index.html"/>
<link rel="next" title="11. Abbreviations" href="Abbreviations.html"/>
<link rel="prev" title="9. Known Issues" href="Known_Issues.html"/>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/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="11. Abbreviations" href="Abbreviations.html" />
<link rel="prev" title="9. Known Issues" href="Known_Issues.html" />


<script src="_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">
<body class="wy-body-for-nav">


<div class="wy-grid-for-nav">
Expand Down Expand Up @@ -111,17 +103,18 @@
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">


<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<nav class="wy-nav-top" aria-label="top navigation">

<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">UMEP Manual</a>

</nav>



<div class="wy-nav-content">

<div class="rst-content">




Expand Down Expand Up @@ -280,9 +273,7 @@


</div>
<div class="articleComments">

</div>

</div>
<footer>

Expand All @@ -304,7 +295,7 @@

</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
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>

Expand All @@ -323,6 +314,7 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
Expand All @@ -340,14 +332,13 @@
<script type="text/javascript" src="_static/js/theme.js"></script>




<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();

SphinxRtdTheme.Navigation.enableSticky();

});
</script>

</script>

</body>
</html>
55 changes: 23 additions & 32 deletions docs/build/html/Getting_Started.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,28 +25,20 @@




<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />



<link rel="stylesheet" href="_static/theme_overrides.css" type="text/css" />



<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="UMEP Manual documentation" href="index.html"/>
<link rel="next" title="3. Pre-Processor" href="pre-processor/Pre-Processor.html"/>
<link rel="prev" title="1. Introduction" href="Introduction.html"/>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/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="3. Pre-Processor" href="pre-processor/Pre-Processor.html" />
<link rel="prev" title="1. Introduction" href="Introduction.html" />


<script src="_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">
<body class="wy-body-for-nav">


<div class="wy-grid-for-nav">
Expand Down Expand Up @@ -114,17 +106,18 @@
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">


<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<nav class="wy-nav-top" aria-label="top navigation">

<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">UMEP Manual</a>

</nav>



<div class="wy-nav-content">

<div class="rst-content">




Expand Down Expand Up @@ -198,7 +191,7 @@
<blockquote>
<div><ol class="arabic simple">
<li>Start <strong>QGIS</strong></li>
<li>Go to: <em>Plugins -&gt; Manage and Install Plugins</em></li>
<li>Go to: <em>Plugins -&gt; Manage and Install Plugins...</em></li>
<li>Search for <strong>UMEP</strong></li>
<li>Click <strong>Install Plugin</strong> (or <em>Upgrade</em> if already have an older version installed from before).</li>
</ol>
Expand All @@ -211,7 +204,7 @@
<li>If you have an installed version of UMEP in your QGIS, uninstall it by going to “Plugins -&gt; Manage and Install Plugins -&gt; Installed -&gt; UMEP” and click <strong>Uninstall plugin</strong></li>
<li>To download UMEP from the repository click this <a class="reference external" href="https://bitbucket.org/fredrik_ucg/umep/downloads">link</a> and download repository</li>
<li>Close QGIS if open</li>
<li>Extract the downloaded zip archive into the folder <strong>C:\Users\.qgis2\python\plugins</strong>. If the folder <strong>plugins</strong> does not exist, install any plugin using <em>Plugins -&gt; Manage and Install Plugins</em> and the folder should appear.</li>
<li>Extract the downloaded zip archive into the folder <strong>C:\Users\\.qgis2\python\plugins</strong>. If the folder <strong>plugins</strong> does not exist, install any plugin using <em>Plugins -&gt; Manage and Install Plugins</em> and the folder should appear.</li>
<li>Rename the extracted folder to <strong>UMEP</strong></li>
<li>Start QGIS. The UMEP plugin should be visible in the QGIS toolbar. If not, go to “Plugins -&gt; Manage and Install Plugins -&gt; All” and search for UMEP. Make sure that you also tick in the box <em>Show also experimental plugins</em> in the “Settings”-tab.</li>
</ol>
Expand Down Expand Up @@ -250,7 +243,7 @@ <h2>2.1. Adding missing Python libraries and other OSGeo functionalities<a class
<li><p class="first">Linux comes with its own Python installation which QGIS makes use of. This makes it possible to directly use <strong>pip</strong> (an installation tool of Python libraries) to add missing libraries. Simply open a terminal window and type <em>sudo pip install pandas</em> if you want to install this library. In order to install pip open a terminal and type: <em>sudo easy_install pip</em>. You might need to restart QGIS to get it to work.</p>
</li>
<li><p class="first">Or refer to <a class="reference external" href="http://docs.qgis.org/testing/en/docs/pyqgis_developer_cookbook/intro.html#the-startup-py-file">startup.py</a> to modify start up file of QGIS by including the paths to <strong>pandas</strong> and <strong>scipy</strong>. An example of startup.py may look like:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">sys</span>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">sys</span>
<span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="s1">&#39;/usr/local/lib/python2.7/site-packages&#39;</span><span class="p">)</span>
</pre></div>
</div>
Expand All @@ -271,7 +264,7 @@ <h2>2.1. Adding missing Python libraries and other OSGeo functionalities<a class
<blockquote>
<div><p>This results in that pip cannot be used directly. However, if you installed QGIS according to the recommendations in <a class="reference external" href="http://urban-climate.net/umep/UMEP_Manual#Getting_Started">Getting started</a> you should have a <strong>OSGeo4W shell</strong> installed where you can use pip to add desired Python libraries. <strong>OSGeo4W shell</strong> is found in the Windows start menu.</p>
<p>You need to run as an administrator of your PC. To do this, right-click on <strong>OSGeo4W shell</strong> and choose <em>run as administrator</em>. In the command window that appear, write:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">pandas</span>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">pandas</span>
</pre></div>
</div>
</div></blockquote>
Expand All @@ -283,7 +276,7 @@ <h2>2.1. Adding missing Python libraries and other OSGeo functionalities<a class
<p><strong>PLEASE NOTICE!</strong></p>
<p>Due to a recent update of <strong>netCDF4</strong> library (1.3.0), the <strong>netCDF4</strong> library has a version conflict related to the <strong>numpy</strong> version currently used in QGIS 2.18.x. This results in that some plugins in UMEP will fail, e.g. LQf.
We have submitted an issue regarding this to the QGIS community. Meanwhile, we recommend UMEP users to downgrade the netCDF4 library to <strong>1.2.9</strong>. This is easiest done by opening the <strong>OSGeo4W shell</strong> and run the two following commands:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">uninstall</span> <span class="n">netCDF4</span>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">uninstall</span> <span class="n">netCDF4</span>
<span class="n">pip</span> <span class="n">install</span> <span class="n">netCDF4</span><span class="o">==</span><span class="mf">1.2</span><span class="o">.</span><span class="mi">9</span>
</pre></div>
</div>
Expand All @@ -310,7 +303,7 @@ <h2>2.1. Adding missing Python libraries and other OSGeo functionalities<a class
<blockquote>
<div><p>to modify start up file of QGIS by including the paths to <strong>pandas</strong> and
<strong>scipy</strong>. An example of startup.py may look like:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">sys</span>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">sys</span>
<span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="s1">&#39;/usr/local/lib/python2.7/site-packages&#39;</span><span class="p">)</span>
</pre></div>
</div>
Expand All @@ -323,9 +316,7 @@ <h2>2.1. Adding missing Python libraries and other OSGeo functionalities<a class


</div>
<div class="articleComments">

</div>

</div>
<footer>

Expand All @@ -347,7 +338,7 @@ <h2>2.1. Adding missing Python libraries and other OSGeo functionalities<a class

</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
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>

Expand All @@ -366,6 +357,7 @@ <h2>2.1. Adding missing Python libraries and other OSGeo functionalities<a class
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
Expand All @@ -383,14 +375,13 @@ <h2>2.1. Adding missing Python libraries and other OSGeo functionalities<a class
<script type="text/javascript" src="_static/js/theme.js"></script>




<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();

SphinxRtdTheme.Navigation.enableSticky();

});
</script>

</script>

</body>
</html>

0 comments on commit aed210c

Please sign in to comment.