Install

ℹ️ Updated to qgis2fds 1.0

This wiki page describes how to set up your qgis2fds installation.

• Requirements
• Install a stable version
• Upgrade a stable version
• Install a development version

Requirements

First, take a look at the [Release notes](Release notes) page to get the required software versions for:

• the QGIS application hosting the qgis2fds plugin, other versions may not work;
• the target NIST FDS solver, other versions may fail to read the exported cases.

Then, install the required version of QGIS on your computer, as explained in the relevant QGIS documentation.

Install a stable version

The qgis2fds plugin is one of the QGIS official centrally managed plugins.

To begin using this plugin, you need to download, install, and activate the latest released version as described in the relevant QGIS documentation. In brief, here is the procedure:

• launch QGIS;
• open the Plugin Manager panel by clicking on the Plugins > Manage and Install Plugins menu;
• select the Not installed option in the Plugin Manager dialog;
• find the qgis2fds plugin and install it by clicking on Install Plugin.

If the plugin has some error it will be listed in the Invalid tab. In this case, please file an issue on the issue tracker.

Upgrade a stable version

The plugin updates are automatically managed by QGIS in the same Plugin Manager panel.

Install a development version

If you want to stay on the edge of development to test brand new features, instead of installing a stable version, you can clone the firetools/qgis2fds repository to your local QGIS plugins folder.

Beware that you need to be Git savvy to install a development version.

The following notes were developed on macOS (Catalina) but have been verified with Windows 10 and Linux. If you find anything unclear, please submit an Issue.

Step 1: Find the right location

In QGIS go to menu Settings > User profiles > Open active profile folder, and from there navigate to the python > plugins folder. This is the right location for the clone of the firetools/qgis2fds repository. Note that, if installing the first plugin yourself, you may need to create the plugins directory.

For example, on macOS you can open a terminal and create the plugins directory by typing:

$ cd ~/Library/Application Support/QGIS/QGIS3/profiles/default/python/
$ mkdir plugins

Step 2: Clone the repo

Next, with the Git tool already installed, get into your plugins directory and clone the qgis2fds repository as follows:

$ cd ~/Library/Application Support/QGIS/QGIS3/profiles/default/python/plugins/
$ git clone [email protected]:firetools/qgis2fds.git

Step 3: Install the plugin

Then install the plugin:

• if QGIS is open, close it and reopen;
• open the Plugin Manager by clicking on Plugins > Manage and Install Plugins;
• select the Installed option in the Plugin Manager dialog;
• find the qgis2fds plugin and enable it by checking the box.

Step 4: Verify installation

You should see the qgis2fds plugin listed and checked, indicating it has been successfully installed.

Close the Plugin Manager and click the Processing tab along the top of the QGIS application. Select Toolbox. If the plugin has been installed correctly, you will see an Export to NIST FDS option in the window.

If the plugin has some error it will be listed in the Invalid tab. In this case, please file an issue on the issue tracker.

Step 5: Update the plugin

Update your local qgis2fds repository to the latest development version by using git commands. For example, on macOS you can open a terminal and type:

$ cd ~/Library/Application Support/QGIS/QGIS3/profiles/default/python/plugins/qgis2fds/
$ git pull