Skip to content

NRCan/CanCurve

Repository files navigation

Documentation Status

CanCurve

CanCurve is an open source tool for developing flood depth-damage (stage-damage) functions for use flood assessments.

CanCurve is undergoing evaluation and validation.

CanCurve Icon

Updates

  • 2024-11-27: UI and documentation improvements.
  • 2024-10-31: add sphinx documentation. improve treatment of units. update to QGIS 3.34.12 v1.0.0
  • 2024-08-22: priority A and B fixes v0.1.0
  • 2024-05-09: small fixes and updates based on initial comments
  • 2024-05-01: initial working release (un tested) v0.0.1

Documentation

Project documentation is here

Installing for the first time

  • Install QGIS 3.34.12 (with Qt 5.15.13)
  • download the cancurve.zip file from the latest release to your local machine
  • in QGIS, Manage and Install Plugins... > Install from ZIP > select the downloaded file
  • we recommended to also install the First Aid plugin for more detailed error messages
  • we recommended to set up the QGIS Debug Log file as shown here
  • CanCurve backend and project data is implemented in SQLite relational databases. For enhanced customization and debugging, it is recommended to install a SQLite viewer + editor like DB Browser for SQLite for working with these files

Re-installation/updating

For best performance: follow similar steps to the above, but be sure to Uninstall the plugin and restart QGIS first

Use

  1. populate the Building Details and Data Input tabs to reflect your archetype and cost-item properties
  2. on the Create Curve tab, either click Run All to execute the full DDF compilation workflow, or select Individual Steps and click through the steps individually. The resulting DDF will be exported in CanFlood format.

Development

see CONTRIBUTING.md

Testing

The Welcome tab contains a temporary Load Testing Values button where you can select from the pre-populated test cases. This should make playing with the tool easier.