Skip to content

Commit

Permalink
deploy: 148cb5e
Browse files Browse the repository at this point in the history
  • Loading branch information
@Huite
Huite committed Dec 19, 2023
1 parent 28ccb02 commit 2cf4f92
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 21 deletions.
6 changes: 3 additions & 3 deletions developer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -159,8 +159,8 @@ <h2 class="anchored" data-anchor-id="pixi">Pixi</h2>
<h3 class="anchored" data-anchor-id="pyinstaller">PyInstaller</h3>
<p>To build the TimML and TTim server application with PyInstaller, run <code>pixi run build-backend</code></p>
<p>This creates a built PyInstaller application in <code>./dist/gistim</code>.</p>
<p>Then, run <code>pixi run create-archive</code> to create a ZIP file of the PyInstaller application.</p>
<p>To test the created ZIP file, start the QGIS plugin and try to install the ZIP file via the “Install TimML and TTim server” button.</p>
<p>Run <code>pixi run zip-backend</code> to create a ZIP file of the PyInstaller application. Run <code>pixi run zip-plugin</code> to create a ZIP file of the QGIS plugin that can be installed in QGIS.</p>
<p>To test the created ZIP files: Install the QGIS from the ZIP file, start the QGIS plugin and try to install the ZIP file via the “Install TimML and TTim server” button.</p>
</section>
</section>
<section id="creating-new-release" class="level2">
Expand All @@ -176,7 +176,7 @@ <h3 class="anchored" data-anchor-id="make-a-github-release">Make a GitHub releas
<li>Publish the release.</li>
<li>PyInstaller applications will now be automatically built.</li>
</ol>
<p>GitHub actions have been defined to automatically build PyInstaller applications on Windows, macOS, and Linux. These run automatically when a new tag is defined. The defined workflows will upload their files to an existing release. This means tags should only be created via the GitHub “Draft a new release” functionality, or no release will be available to upload to.</p>
<p>GitHub actions have been defined to automatically build PyInstaller applications on Windows, macOS, and Linux; and to create a ZIP file of the QGIS plugin. These run automatically when a new tag is defined. The defined workflows will upload their files to an existing release. This means tags should only be created via the GitHub “Draft a new release” functionality, or no release will be available to upload to.</p>
</section>
<section id="upload-the-plugin-to-the-qgis-respository" class="level3">
<h3 class="anchored" data-anchor-id="upload-the-plugin-to-the-qgis-respository">Upload the plugin to the QGIS respository</h3>
Expand Down
2 changes: 1 addition & 1 deletion index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -181,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="1702921245367" data-listing-reading-time-sort="1">
<div class="g-col-1" data-index="0" data-listing-file-modified-sort="1702983194795" 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
21 changes: 11 additions & 10 deletions install.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,8 @@ <h2 id="toc-title">On this page</h2>
<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-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>
<li><a href="#method-a-from-the-qgis-plugin-database" id="toc-method-a-from-the-qgis-plugin-database" class="nav-link" data-scroll-target="#method-a-from-the-qgis-plugin-database">Method A: From the QGIS plugin database</a></li>
<li><a href="#method-b-from-zip-file-recommended-for-now" id="toc-method-b-from-zip-file-recommended-for-now" class="nav-link" data-scroll-target="#method-b-from-zip-file-recommended-for-now">Method B: From ZIP file (recommended for now)</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>
Expand Down Expand Up @@ -156,9 +156,9 @@ <h2 class="anchored" data-anchor-id="install-qgis">1. Install QGIS</h2>
</section>
<section id="install-the-qgis-plugin" class="level2">
<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>
<section id="method-a-from-the-qgis-plugin-database" class="level3">
<h3 class="anchored" data-anchor-id="method-a-from-the-qgis-plugin-database">Method A: From the QGIS 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 B.</p>
<ol type="1">
<li>Open QGIS.</li>
<li>At the top, find the Plugins menu (~sixth object in the menubar).</li>
Expand All @@ -168,25 +168,26 @@ <h3 class="anchored" data-anchor-id="method-1-from-the-gqis-plugin-database">Met
<li>Click "Install Plugin".</li>
</ol>
</section>
<section id="method-2-from-zip-recommended" class="level3">
<h3 class="anchored" data-anchor-id="method-2-from-zip-recommended">Method 2: From Zip (recommended)</h3>
<section id="method-b-from-zip-file-recommended-for-now" class="level3">
<h3 class="anchored" data-anchor-id="method-b-from-zip-file-recommended-for-now">Method B: From ZIP file (recommended for now)</h3>
<ol type="1">
<li>Download the "QGIS-TIM-plugin.zip" (do not unzip!) from the <a href="https://deltares.thegood.cloud/s/AefTz97ZHbWS4RT" target="_blank">iMOD-Suite download portal.</a></li>
<li>Download the "QGIS-Tim-plugin.zip" from the <a href="https://github.com/Deltares/QGIS-Tim/releases">GitHub Releases page</a> (do not unzip!).</li>
<li>Open QGIS.</li>
<li>At the top, find the Plugins menu (~sixth object in the menubar).</li>
<li>Find "Manage and Install plugins" (~first object in drop-down).</li>
<li>Find "Install from ZIP" (~fourth in left section).</li>
<li>Enter the path to the file "QGIS-TIM-plugin.zip".</li>
<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>
<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%"></p>
<p>By clicking the icon, the plugin is started.</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>Start the QGIS-Tim plugin by clicking the QGIS-Tim icon in the toolbar.</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>
Expand Down
10 changes: 5 additions & 5 deletions search.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,21 @@
"href": "developer.html",
"title": "Developer Notes",
"section": "",
"text": "QGIS-Tim uses pixi to manage installing dependencies and run common tasks.\nFollow the instructions on the Getting Started page.\n\n\nTo build the TimML and TTim server application with PyInstaller, run pixi run build-backend\nThis creates a built PyInstaller application in ./dist/gistim.\nThen, run pixi run create-archive to create a ZIP file of the PyInstaller application.\nTo test the created ZIP file, start the QGIS plugin and try to install the ZIP file via the “Install TimML and TTim server” button."
"text": "QGIS-Tim uses pixi to manage installing dependencies and run common tasks.\nFollow the instructions on the Getting Started page.\n\n\nTo build the TimML and TTim server application with PyInstaller, run pixi run build-backend\nThis creates a built PyInstaller application in ./dist/gistim.\nRun pixi run zip-backend to create a ZIP file of the PyInstaller application. Run pixi run zip-plugin to create a ZIP file of the QGIS plugin that can be installed in QGIS.\nTo test the created ZIP files: Install the QGIS from the ZIP file, start the QGIS plugin and try to install the ZIP file via the “Install TimML and TTim server” button."
},
{
"objectID": "developer.html#pixi",
"href": "developer.html#pixi",
"title": "Developer Notes",
"section": "",
"text": "QGIS-Tim uses pixi to manage installing dependencies and run common tasks.\nFollow the instructions on the Getting Started page.\n\n\nTo build the TimML and TTim server application with PyInstaller, run pixi run build-backend\nThis creates a built PyInstaller application in ./dist/gistim.\nThen, run pixi run create-archive to create a ZIP file of the PyInstaller application.\nTo test the created ZIP file, start the QGIS plugin and try to install the ZIP file via the “Install TimML and TTim server” button."
"text": "QGIS-Tim uses pixi to manage installing dependencies and run common tasks.\nFollow the instructions on the Getting Started page.\n\n\nTo build the TimML and TTim server application with PyInstaller, run pixi run build-backend\nThis creates a built PyInstaller application in ./dist/gistim.\nRun pixi run zip-backend to create a ZIP file of the PyInstaller application. Run pixi run zip-plugin to create a ZIP file of the QGIS plugin that can be installed in QGIS.\nTo test the created ZIP files: Install the QGIS from the ZIP file, start the QGIS plugin and try to install the ZIP file via the “Install TimML and TTim server” button."
},
{
"objectID": "developer.html#creating-new-release",
"href": "developer.html#creating-new-release",
"title": "Developer Notes",
"section": "Creating new release",
"text": "Creating new release\n\nMake a GitHub release\nTo create a new release:\n\nGo to the QGIS-Tim releases page\nClick on the “Draft a new release” button.\nCreate a new tag.\nWrite a title and description.\nPublish the release.\nPyInstaller applications will now be automatically built.\n\nGitHub actions have been defined to automatically build PyInstaller applications on Windows, macOS, and Linux. These run automatically when a new tag is defined. The defined workflows will upload their files to an existing release. This means tags should only be created via the GitHub “Draft a new release” functionality, or no release will be available to upload to.\n\n\nUpload the plugin to the QGIS respository\nLogin to the QGIS plugin repository and upload the ZIP file of the QGIS plugin."
"text": "Creating new release\n\nMake a GitHub release\nTo create a new release:\n\nGo to the QGIS-Tim releases page\nClick on the “Draft a new release” button.\nCreate a new tag.\nWrite a title and description.\nPublish the release.\nPyInstaller applications will now be automatically built.\n\nGitHub actions have been defined to automatically build PyInstaller applications on Windows, macOS, and Linux; and to create a ZIP file of the QGIS plugin. These run automatically when a new tag is defined. The defined workflows will upload their files to an existing release. This means tags should only be created via the GitHub “Draft a new release” functionality, or no release will be available to upload to.\n\n\nUpload the plugin to the QGIS respository\nLogin to the QGIS plugin repository and upload the ZIP file of the QGIS plugin."
},
{
"objectID": "install.html",
Expand All @@ -39,14 +39,14 @@
"href": "install.html#install-the-qgis-plugin",
"title": "Install",
"section": "2. Install the QGIS plugin",
"text": "2. Install the QGIS plugin\n\nMethod 1: From the GQIS plugin database\nNB Due to ongoing developments new features and bug fixes might not be part of this release. Consider installation method 2.\n\nOpen QGIS.\nAt the top, find the Plugins menu (~sixth object in the menubar).\nFind \"Manage and Install plugins\" (~first object in drop-down).\nFind \"All\" (~first in left section).\nSearch for \"Qgis-Tim\".\nClick \"Install Plugin\".\n\n\n\nMethod 2: From Zip (recommended)\n\nDownload the \"QGIS-TIM-plugin.zip\" (do not unzip!) from the iMOD-Suite download portal.\nOpen QGIS.\nAt the top, find the Plugins menu (~sixth object in the menubar).\nFind \"Manage and Install plugins\" (~first object in drop-down).\nFind \"Install from ZIP\" (~fourth in left section).\nEnter the path to the file \"QGIS-TIM-plugin.zip\".\nClick \"Install Plugin\".\n\nThis will add an icon to the toolbar(s). By clicking the icon, the plugin is started. The QGIS plugin automatically starts an extra window for the background calculation of a TIM model. This black window is called Python.exe and can be minimized or even closed after the calculation."
"text": "2. Install the QGIS plugin\n\nMethod A: From the QGIS plugin database\nNB Due to ongoing developments new features and bug fixes might not be part of this release. Consider installation method B.\n\nOpen QGIS.\nAt the top, find the Plugins menu (~sixth object in the menubar).\nFind \"Manage and Install plugins\" (~first object in drop-down).\nFind \"All\" (~first in left section).\nSearch for \"Qgis-Tim\".\nClick \"Install Plugin\".\n\n\n\nMethod B: From ZIP file (recommended for now)\n\nDownload the \"QGIS-Tim-plugin.zip\" from the GitHub Releases page (do not unzip!).\nOpen QGIS.\nAt the top, find the Plugins menu (~sixth object in the menubar).\nFind \"Manage and Install plugins\" (~first object in drop-down).\nFind \"Install from ZIP\" (~fourth in left section).\nEnter the path to the file \"QGIS-TIM-plugin.zip\".\nClick \"Install Plugin\".\n\nThis will add an icon to the toolbar(s). \nBy clicking the icon, the plugin is started."
},
{
"objectID": "install.html#install-the-timml-and-ttim-server",
"href": "install.html#install-the-timml-and-ttim-server",
"title": "Install",
"section": "3. Install the TimML and TTim server",
"text": "3. Install the TimML and TTim server\nWith 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.\n\nStart the QGIS-Tim plugin by clicking the icon in the toolbar: \nFind and click the “Install TimML and TTim server” button at the bottom of the plugin window.\nClick the “Install latest release from GitHub” button to download and install the server program.\n\nSpecific releases can also be manually downloaded from the GitHub Releases page:\n\nDownload the gistim ZIP file for your platform: Windows, macOS, or Linux.\nFind and click the “Install TimML and TTim server” button at the bottom of the plugin window.\nSet the path to the downloaded ZIP file in the “Install from ZIP file” section.\nClick the “Install” button."
"text": "3. Install the TimML and TTim server\nWith 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.\n\nStart the QGIS-Tim plugin by clicking the QGIS-Tim icon in the toolbar.\nFind and click the “Install TimML and TTim server” button at the bottom of the plugin window.\nClick the “Install latest release from GitHub” button to download and install the server program.\n\nSpecific releases can also be manually downloaded from the GitHub Releases page:\n\nDownload the gistim ZIP file for your platform: Windows, macOS, or Linux.\nFind and click the “Install TimML and TTim server” button at the bottom of the plugin window.\nSet the path to the downloaded ZIP file in the “Install from ZIP file” section.\nClick the “Install” button."
},
{
"objectID": "tutorial_TheHague.html",
Expand Down
4 changes: 2 additions & 2 deletions tutorial.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ <h1 class="title"><i class="fa-solid fa-book" aria-label="book"></i> Tutorials</

<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="1702921245367" data-listing-reading-time-sort="30">
<div class="g-col-1" data-index="0" data-listing-file-modified-sort="1702983194795" data-listing-reading-time-sort="30">
<a href="./tutorial_Rijsenhout.html" class="quarto-grid-link">
<div class="quarto-grid-item card h-100 card-left">
<p class="card-img-top"><img src="figures/tutorial/GeoTOP-Verticaledoorsnede.png" style="height: 150px;" class="thumbnail-image card-img"/></p>
Expand All @@ -242,7 +242,7 @@ <h5 class="no-anchor card-title listing-title">
</div>
</a>
</div>
<div class="g-col-1" data-index="1" data-listing-file-modified-sort="1702921245367" data-listing-reading-time-sort="45">
<div class="g-col-1" data-index="1" data-listing-file-modified-sort="1702983194795" data-listing-reading-time-sort="45">
<a href="./tutorial_TheHague.html" class="quarto-grid-link">
<div class="quarto-grid-item card h-100 card-left">
<p class="card-img-top"><img src="figures/tutorial/photo-TheHagueCityCentre.png" style="height: 150px;" class="thumbnail-image card-img"/></p>
Expand Down

0 comments on commit 2cf4f92

Please sign in to comment.