# 
# RiskScape™ Copyright New Zealand Institute for Earth Science Limited
# (Earth Sciences New Zealand) is distributed for research purposes only
# under the terms of AGPLv3.
# 
# RiskScape™ Copyright 2025 New Zealand Institute for Earth Science
# Limited (Earth Sciences New Zealand). All rights reserved. Source code
# available under the AGPLv3.
# 
# This program is free software: you can redistribute it and/or modify it under
#  the terms of the GNU Affero General Public License as published by the Free
#  Software Foundation, either version 3 of the License, or (at your option) any
#  later version.
# 
# This program is distributed for RESEARCH PURPOSES ONLY, in the hope that it will
# be useful for research and education initiatives.
# 
# If you are not a researcher, or you are a researcher who wishes to use this
# program on terms other than AGPLv3 (including those who wish to restrict the
# distribution of any source code created using this program), please contact:
# https://riskscape.org.nz
# 
# This program is distributed WITHOUT ANY WARRANTY; without even the implied
# warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Affero General Public License for more details.  You should have received a copy
# of the GNU Affero General Public License along with this program.  If not, see
# <http://www.gnu.org/licenses/>.
# 
# By way of summary only, under the AGPLv3:
#     • Permissions of this strongest copyleft license are conditioned
#       on making available complete source code of licensed works and
#       modifications, which include larger works using a licensed work,
#       under the same license.
#     • Copyright and license notices must be preserved.
#     • Contributors provide an express grant of patent rights.
#     • When a modified version is used to provide a service over a
#       network, the complete source code of the modified version must be made
#       available.
# 
[model basic-table]
framework = pipeline
location = basic-pipeline.txt
description = A simple model to apply a function to a "table" of data
param.relation = 'data/Buildings_SE_Upolu_inundation.shp'
param.function = Samoa_Building_Fragility_DS5(exposure, hazard)
param.exposure_attributes = *
param.hazard_attributes = inundation

[function Samoa_Building_Fragility_DS5]
description = determines the probability of a building being in Damage State 5 (complete structural collapse)
location = Samoa_Building_Fragility_DS5.py
argument-types = [ building: struct(Cons_Frame: text), hazard_depth: nullable(floating) ]
return-type = floating
framework = jython

[model table-aggregation]
framework = pipeline
location = aggregation-pipeline.txt
description = A simple model to apply a function to a "table" of data
param.relation = 'data/Buildings_SE_Upolu_inundation.shp'
param.function = Samoa_Building_Fragility_DS5(exposure, hazard)
param.exposure_attributes = *
param.hazard_attributes = inundation
param.filter = true
param.aggregation_layer = 'data/Samoa_constituencies.shp'
param.buffer_distance = 10000
param.aggregate_by = region
param.aggregate_function = mean(consequence)

