diff --git a/developer.html b/developer.html index 917732e..6da169b 100644 --- a/developer.html +++ b/developer.html @@ -159,8 +159,8 @@

Pixi

PyInstaller

To build the TimML and TTim server application with PyInstaller, run pixi run build-backend

This creates a built PyInstaller application in ./dist/gistim.

-

Then, run pixi run create-archive to create a ZIP file of the PyInstaller application.

-

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.

+

Run 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.

+

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.

@@ -176,7 +176,7 @@

Make a GitHub releas
  • Publish the release.
  • PyInstaller applications will now be automatically built.
    • -

    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.

    +

    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.

    Upload the plugin to the QGIS respository

    diff --git a/index.html b/index.html index f082c61..51bc804 100644 --- a/index.html +++ b/index.html @@ -181,7 +181,7 @@

    QGIS-Tim

    -
    +

    diff --git a/install.html b/install.html index 61bbbbe..8591a31 100644 --- a/install.html +++ b/install.html @@ -122,8 +122,8 @@

    On this page

  • 1. Install QGIS
  • 2. Install the QGIS plugin
  • 3. Install the TimML and TTim server
    • @@ -156,9 +156,9 @@

    1. Install QGIS

    2. Install the QGIS plugin

    -
    -

    Method 1: From the GQIS plugin database

    -

    NB Due to ongoing developments new features and bug fixes might not be part of this release. Consider installation method 2.

    +
    +

    Method A: From the QGIS plugin database

    +

    NB Due to ongoing developments new features and bug fixes might not be part of this release. Consider installation method B.

    1. Open QGIS.
    2. At the top, find the Plugins menu (~sixth object in the menubar).
      3. @@ -168,10 +168,10 @@

      Met
    3. Click "Install Plugin".

    -

    3. Install the TimML and TTim server

    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.

      -
    1. Start the QGIS-Tim plugin by clicking the icon in the toolbar:
      2. +
    2. Start the QGIS-Tim plugin by clicking the QGIS-Tim icon in the toolbar.
    3. Find and click the “Install TimML and TTim server” button at the bottom of the plugin window.
    4. Click the “Install latest release from GitHub” button to download and install the server program.
    diff --git a/search.json b/search.json index c24c65e..bc5e0eb 100644 --- a/search.json +++ b/search.json @@ -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", @@ -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", diff --git a/tutorial.html b/tutorial.html index c38d590..7cbddee 100644 --- a/tutorial.html +++ b/tutorial.html @@ -222,7 +222,7 @@

    Tutorials
    -
    +

    @@ -242,7 +242,7 @@
    -
    +