Skip to content

Commit

Permalink
deploy: 73ab69a
Browse files Browse the repository at this point in the history
  • Loading branch information
@Huite
Huite committed Dec 18, 2023
1 parent 6885548 commit 28ccb02
Show file tree
Hide file tree
Showing 9 changed files with 664 additions and 203 deletions.
4 changes: 4 additions & 0 deletions deltaforge_install.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,10 @@
<a class="nav-link" href="./tutorial.html" rel="" target="">
<span class="menu-text">Tutorials</span></a>
</li>
<li class="nav-item">
<a class="nav-link" href="./developer.html" rel="" target="">
<span class="menu-text">Development</span></a>
</li>
</ul>
<ul class="navbar-nav navbar-nav-scroll ms-auto">
<li class="nav-item compact">
Expand Down
427 changes: 427 additions & 0 deletions developer.html
View file

Large diffs are not rendered by default.

6 changes: 5 additions & 1 deletion index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,10 @@
<a class="nav-link" href="./tutorial.html" rel="" target="">
<span class="menu-text">Tutorials</span></a>
</li>
<li class="nav-item">
<a class="nav-link" href="./developer.html" rel="" target="">
<span class="menu-text">Development</span></a>
</li>
</ul>
<ul class="navbar-nav navbar-nav-scroll ms-auto">
<li class="nav-item compact">
Expand Down Expand Up @@ -177,7 +181,7 @@ <h1 class="title">QGIS-Tim</h1>

<div class="quarto-listing quarto-listing-container-grid" id="listing-listing">
<div class="list grid quarto-listing-cols-3">
<div class="g-col-1" data-index="0" data-listing-file-modified-sort="1702844972405" data-listing-reading-time-sort="1">
<div class="g-col-1" data-index="0" data-listing-file-modified-sort="1702921245367" data-listing-reading-time-sort="1">
<a href="./tutorial.html" class="quarto-grid-link">
<div class="quarto-grid-item card h-100 card-left">
<p class="card-img-top">
Expand Down
57 changes: 25 additions & 32 deletions install.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,10 @@
<a class="nav-link" href="./tutorial.html" rel="" target="">
<span class="menu-text">Tutorials</span></a>
</li>
<li class="nav-item">
<a class="nav-link" href="./developer.html" rel="" target="">
<span class="menu-text">Development</span></a>
</li>
</ul>
<ul class="navbar-nav navbar-nav-scroll ms-auto">
<li class="nav-item compact">
Expand All @@ -116,16 +120,12 @@ <h2 id="toc-title">On this page</h2>

<ul>
<li><a href="#install-qgis" id="toc-install-qgis" class="nav-link active" data-scroll-target="#install-qgis">1. Install QGIS</a></li>
<li><a href="#install-gistim-in-a-seperate-python-environment" id="toc-install-gistim-in-a-seperate-python-environment" class="nav-link" data-scroll-target="#install-gistim-in-a-seperate-python-environment">2. Install <code>gistim</code> in a seperate Python environment</a>
<ul class="collapse">
<li><a href="#method-1-with-deltaforge-recommended" id="toc-method-1-with-deltaforge-recommended" class="nav-link" data-scroll-target="#method-1-with-deltaforge-recommended">Method 1: with Deltaforge (recommended)</a></li>
<li><a href="#method-2-with-miniforge" id="toc-method-2-with-miniforge" class="nav-link" data-scroll-target="#method-2-with-miniforge">Method 2: with Miniforge</a></li>
</ul></li>
<li><a href="#install-the-qgis-plugin" id="toc-install-the-qgis-plugin" class="nav-link" data-scroll-target="#install-the-qgis-plugin">3. Install the QGIS plugin</a>
<li><a href="#install-the-qgis-plugin" id="toc-install-the-qgis-plugin" class="nav-link" data-scroll-target="#install-the-qgis-plugin">2. Install the QGIS plugin</a>
<ul class="collapse">
<li><a href="#method-1-from-the-gqis-plugin-database" id="toc-method-1-from-the-gqis-plugin-database" class="nav-link" data-scroll-target="#method-1-from-the-gqis-plugin-database">Method 1: From the GQIS plugin database</a></li>
<li><a href="#method-2-from-zip-recommended" id="toc-method-2-from-zip-recommended" class="nav-link" data-scroll-target="#method-2-from-zip-recommended">Method 2: From Zip (recommended)</a></li>
</ul></li>
<li><a href="#install-the-timml-and-ttim-server" id="toc-install-the-timml-and-ttim-server" class="nav-link" data-scroll-target="#install-the-timml-and-ttim-server">3. Install the TimML and TTim server</a></li>
</ul>
</nav>
</div>
Expand All @@ -152,33 +152,10 @@ <h1 class="title">Install</h1>
<p>QGIS-Tim consists of two parts: A QGIS plugin and the <code>gistim</code> Python package, which runs in a separate Python environment. The installation of QGIS-Tim therfore consists of three steps:</p>
<section id="install-qgis" class="level2">
<h2 class="anchored" data-anchor-id="install-qgis">1. Install QGIS</h2>
<p>Download and install a recent version of QGIS (&gt;3.22): <a href="https://www.qgis.org/en/site/forusers/download.html" target="_blank">https://www.qgis.org/en/site/forusers/download.html</a></p>
</section>
<section id="install-gistim-in-a-seperate-python-environment" class="level2">
<h2 class="anchored" data-anchor-id="install-gistim-in-a-seperate-python-environment">2. Install <code>gistim</code> in a seperate Python environment</h2>
<p><code>gistim</code> requires a seperate Python environment, because it depends on packages incompatible with the packages in QGIS’ own Python environment. There are two approaches: either using the fully-fletched Deltaforge distribution (Recommended) or the leaner Miniforge distribution.</p>
<section id="method-1-with-deltaforge-recommended" class="level3">
<h3 class="anchored" data-anchor-id="method-1-with-deltaforge-recommended">Method 1: with Deltaforge (recommended)</h3>
<ol type="1">
<li><a href="https://download.deltares.nl/imod-suite/" target="_blank">Download and install Deltaforge</a>. <strong>Make sure you use Deltaforge version 0.3.0 or higher!</strong></li>
<li>Open the Deltaforge prompt (search in Windows Start for "Deltaforge Prompt").</li>
<li>Configure the gistim installation, so that the QGIS plugin is able to find it. Run: <code>python -m gistim configure</code></li>
</ol>
</section>
<section id="method-2-with-miniforge" class="level3">
<h3 class="anchored" data-anchor-id="method-2-with-miniforge">Method 2: with Miniforge</h3>
<ol type="1">
<li><a href="https://github.com/conda-forge/miniforge" target="_blank">Download and install a miniforge Python installation</a></li>
<li>Open the miniforge prompt (search in Windows Start for "Miniforge Prompt").</li>
<li>Create a new conda environment, run: <code>conda create \--name tim python=3.9</code></li>
<li>Activate the environment: <code>conda activate tim</code></li>
<li>Run: <code>conda install -c conda-forge gistim</code></li>
<li>Configure the gistim installation, so that the QGIS plugin is able to find it. Run: <code>python -m gistim configure</code></li>
</ol>
</section>
<p>Download and install a recent version of QGIS (&gt;=3.28): <a href="https://www.qgis.org/en/site/forusers/download.html" target="_blank">https://www.qgis.org/en/site/forusers/download.html</a></p>
</section>
<section id="install-the-qgis-plugin" class="level2">
<h2 class="anchored" data-anchor-id="install-the-qgis-plugin">3. Install the QGIS plugin</h2>
<h2 class="anchored" data-anchor-id="install-the-qgis-plugin">2. Install the QGIS plugin</h2>
<section id="method-1-from-the-gqis-plugin-database" class="level3">
<h3 class="anchored" data-anchor-id="method-1-from-the-gqis-plugin-database">Method 1: From the GQIS plugin database</h3>
<p><strong>NB</strong> Due to ongoing developments new features and bug fixes might not be part of this release. Consider installation method 2.</p>
Expand All @@ -203,9 +180,25 @@ <h3 class="anchored" data-anchor-id="method-2-from-zip-recommended">Method 2: Fr
<li>Click "Install Plugin".</li>
</ol>
<p>This will add an icon to the toolbar(s). <img src="figures/tutorial/button-Qgis-tim.png" class="img-fluid" style="width:6.0%"> By clicking the icon, the plugin is started. <br> The QGIS plugin automatically starts an extra window for the background calculation of a TIM model. This black window is called <em>Python.exe</em> and can be minimized or even closed after the calculation.</p>
</section>
</section>
<section id="install-the-timml-and-ttim-server" class="level2">
<h2 class="anchored" data-anchor-id="install-the-timml-and-ttim-server">3. Install the TimML and TTim server</h2>
<p>With the plugin installed, we can already define model input and convert it to Python scripts or JSON files. To run TimML and TTim computations directly from QGIS, we need to install a server program which contains TimML and TTim.</p>
<ol type="1">
<li>Start the QGIS-Tim plugin by clicking the icon in the toolbar: <img src="figures/tutorial/button-Qgis-tim.png" class="img-fluid" style="width:6.0%"></li>
<li>Find and click the “Install TimML and TTim server” button at the bottom of the plugin window.</li>
<li>Click the “Install latest release from GitHub” button to download and install the server program.</li>
</ol>
<p>Specific releases can also be manually downloaded from the <a href="https://github.com/Deltares/QGIS-Tim/releases">GitHub Releases page</a>:</p>
<ol type="1">
<li>Download the gistim ZIP file for your platform: Windows, macOS, or Linux.</li>
<li>Find and click the “Install TimML and TTim server” button at the bottom of the plugin window.</li>
<li>Set the path to the downloaded ZIP file in the “Install from ZIP file” section.</li>
<li>Click the “Install” button.</li>
</ol>


</section>
</section>

</main> <!-- /main -->
Expand Down
10 changes: 5 additions & 5 deletions listings.json
View file
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
[
{
"listing": "/tutorial.html",
"listing": "/index.html",
"items": [
"/tutorial_Rijsenhout.html",
"/tutorial_TheHague.html"
"/tutorial.html"
]
},
{
"listing": "/index.html",
"listing": "/tutorial.html",
"items": [
"/tutorial.html"
"/tutorial_Rijsenhout.html",
"/tutorial_TheHague.html"
]
}
]
Loading

0 comments on commit 28ccb02

Please sign in to comment.