Open source flood risk modelling toolbox for Canada

Updated and tested against QGIS 3.22.8

We welcome/encourage any comments, bugs, or issues you have or find. Please create a GitHub 'issue' ticket following these instructions to let us know about these things.

Happy flood risk modelling!

Documentation is provided for the latest and archived versions.

v1.2.0 is released with the following major new features:

1. new tool for generating a pdf report of your model.

v1.1.0 is released with three major new features:

1. Very nice sphinx/readTheDocs documentation thanks in large part to Dhanyatha. This is much easier to browse than the previous pdfs and facilitates preservation of previous, current, and development (and eventually French) versions of the manual.
2. new module providing workflow and tools for performing sensitivity analysis on a L1 or L2 CanFlood models. This can be helpful in understanding and communicating the uncertainty in your model, as well as help identify which parameters should be prioritized during data collection.
3. per-asset Sampling for Complex Geometries providing more flexibility in how hazard variables are sampled from complex geometries.

1. Ensure the QGIS and Qt version 'tested' above is installed and working on your system (Qgis all releases download page). Ensure the 'processing' plugin is installed and enabled in QGIS.

2. Ensure the required python packages or dependencies shown in the requirements file are installed. Typically, this step is skipped and users just attempt to use the tool until an error is thrown. As of last test, a default install of QGIS 3.16 included all the CanFlood dependencies except 'openpyxl' (needed by the 'results - BCA' tools). Instructions for installing additional python packages in QGIS are provided here.

3. Install the plugin from the QGIS repository (Plugins > Manage and Install... > All > search for CanFlood > Install). If a dependency error is thrown, see 'troubleshooting' below. If successful, you should see the three CanFlood buttons on your toolbar and a 'CanFlood' entry in the 'Plugins' menu.

4. If you're re-installing or upgrading, it is safest to first uninstall CanFlood and restart QGIS before continuing with a new install.

5. We recommend implementing the QGIS DEBUG logger for more detailed readouts and CanFlood model debugging. See this post for instructions.

Install from the QGIS plugin repository.

As both QGIS and CanFlood are active open source projects, getting your installation configured can be challenging, especially if you lack admin privileges to your machine and have no pyqgis experience. Check the issues for solutions.

QGIS has retired their old installer and is no longer supporting 32-bit binaries. If you get a 'Couldn't load plugin 'canflood'' error after installing the plugin (or you have a Qt version <5.15.2), you need to install QGIS using the new standalone (msi) installers, see this solution.

Some installations of QGIS may not come pre-installed with all the required python packages and dependencies listed in the requirements file. If you get a ModuleNotFound error, your QGIS install does not have the required packages. This can easily be remedied by a user with admin privileges and working pyqgis knowledge. The following solution provides some guidance on installing third party python modules, but you'll likely need admin privileges.

To get started with CanFlood, we recommend reading the documentation and working through the tutorials.

As CanFlood is an active open-sourced project, users will often encounter errors which can be frustrating. To work through these errors, we recommend first checking to see if there is a similar issue on the above 'issues' tab. If so, hopefully the thread will resolve the problem, if not, reply to the thread with more details on your problem and why the posted solution did not work.

If there is no issue ticket yet, follow the instructions here to post a new issue.

We agree. Consider contacting a CanFlood developer to sponsor improvement that suites your needs, or joining the development community. Whether you'd like to integrate CanFlood modelling with some existing local databases, or integrate some other flood risk models into your analysis, or develop new output styles, the CanFlood project wants to hear from you. Please post a new issue here with an 'enhancement' label.

Boîte à outils de modélisation des risques d’inondation libre d’accès pour le Canada

Mis à jour et mis à l’essai par rapport à QGIS 3.22.8 (Qt 5.15.3) Nous vous encourageons à nous faire part de vos commentaires ou à nous signaler les bogues ou problèmes que vous rencontrez. Le cas échéant, veuillez créer un billet de « problème » GitHub en suivant ces instructions pour nous en faire part.

Bonne modélisation de risques d’inondation!

De la documentation est fournie pour la plus récente version et les versions archivées.

La v1.2.0 est publiée avec les nouvelles fonctionnalités majeures suivantes:

1. Nouvel outil pour générer un rapport de votre modèle en format PDF.

La v1.1.0 comprend les trois nouvelles fonctionnalités majeures suivantes:

1. Très bonne documentation sur Sphinx et Read the Docs, créée en grande partie par Dhanyatha. Cette version est beaucoup plus facile à consulter que les précédents fichiers en format PDF, et elle facilite la conservation des versions précédentes, actuelles et en développement (et ultimement en français) du manuel.
2. Nouveau module fournissant un flux de travail et des outils pour effectuer une analyse de sensibilité sur un modèle CanFlood L1 ou L2. Il peut être utile pour comprendre et communiquer l’incertitude subsistant dans votre modèle, ainsi que pour déterminer les paramètres auxquels accorder la priorité lors de la collecte des données.
3. Échantillonnage par actif pour les géométries complexes offrant plus de souplesse dans la façon dont les variables de risque sont échantillonnées à partir de géométries complexes.

1. Assurez-vous que les versions de QGIS et de Qt ci-dessus mises à l’essai ci-dessus sont installées et fonctionnent sur votre système (Page de téléchargement de toutes les versions de QGIS). Assurez-vous que le plugiciel de traitement (« processing ») est installé et activé dans QGIS.

2. Assurez-vous que les modules Python requis et les dépendances indiquées dans le fichier des exigences sont installés. Normalement, cette étape est ignorée et les utilisateurs tentent simplement d’utiliser l’outil jusqu’à ce qu’une erreur se produise. En date du dernier essai, une installation par défaut de QGIS 3.16 incluait toutes les dépendances de CanFlood à l’exception de « openpyxl » (nécessaire pour les outils « résultats – ACC »). Des instructions pour l’installation de modules Python supplémentaires dans QGIS sont fournies ici.

3. Installez le plugiciel à partir du référentiel QGIS (Plugins > Manage and Install... > All > recherchez CanFlood > Install). Si une erreur de dépendance se produit, consultez la section « Dépannage » ci-dessous. Si vous avez réussi, vous devriez voir les trois boutons de CanFlood sur votre barre d’outils et une entrée « CanFlood » dans le menu « Plugins ».

4. Si vous effectuez une réinstallation ou une mise à niveau, il est plus sûr de désinstaller CanFlood et de redémarrer QGIS avant de procéder à une nouvelle installation.

5. Nous recommandons d’utiliser l’enregistreur chronologique QGIS DEBUG pour des lectures plus détaillées et le débogage de modèles CanFlood. Voir cette publication pour les instructions.

Lancez l’installation à partir du référentiel de plugiciels QGIS.

Comme QGIS et CanFlood sont tous deux des projets actifs à code source ouvert, la configuration de votre installation peut s’avérer difficile, surtout si vous ne disposez pas des privilèges d’administrateur sur votre appareil et que vous n’avez aucune expérience avec pyqgis. Consultez les problèmes pour trouver des solutions.

QGIS a retiré son ancien installateur et ne prend plus en charge les binaires 32 bits. Si vous obtenez une erreur « Couldn’t load plugiciel canflood » après avoir installé le plugiciel (ou si vous avez une version de Qt antérieure à la version 5.15.2), vous devez installer QGIS en utilisant les nouveaux installateurs (msi) autonomes. Référez-vous à cette solution.

Certaines installations de QGIS peuvent ne pas être préinstallées avec tous les modules Python requis et les dépendances répertoriées dans le fichier des exigences. Si vous obtenez une erreur ModuleNotFound, votre installation de QGIS ne dispose pas des modules requis. Ceci peut être facilement corrigé par un utilisateur ayant des privilèges d’administrateur et une connaissance pratique de pyqgis. La solution suivante fournit quelques conseils sur l’installation de modules Python tiers, mais vous aurez probablement besoin de privilèges d’administrateur.

Pour commencer à utiliser CanFlood, nous vous recommandons de lire la documentation et de suivre les tutoriels.

Comme CanFlood est un projet actif à code source ouvert, les utilisateurs rencontreront souvent des erreurs qui pourraient s’avérer frustrantes. Pour résoudre ces erreurs, nous vous recommandons de vérifier d’abord s’il existe un problème comparable dans l’onglet des problèmes ci-dessus. Si c’est le cas, nous espérons que le fil de discussion vous aidera à le résoudre. Sinon, répondez au fil de discussion en donnant plus de détails sur votre problème et en expliquant pourquoi la solution affichée n’a pas fonctionné. S’il n’y a pas encore de billet de problème, suivez les instructions ici pour publier un nouveau problème.

Nous sommes du même avis. Envisagez de communiquer avec un développeur de CanFlood pour lui faire part d’une amélioration qui répondrait à vos besoins, ou de devenir membre de la communauté de développement. Que vous souhaitiez intégrer la modélisation de CanFlood à certaines bases de données locales existantes, intégrer d’autres modèles de risques d’inondation dans votre analyse, ou encore mettre au point de nouveaux styles d’extrants, l’équipe du projet CanFlood souhaite vous entendre. Veuillez publier un nouveau problème ici avec l’étiquette « amélioration ».