Merge pull request #140 from nismod/water_demand

Water demand integration

README.md

@@ -242,6 +242,7 @@ bash ./provision/install_energy_demand.sh .
 bash ./provision/install_energy_supply.sh . ./path/to/xpress_install_dir
 bash ./provision/install_transport.sh .
 bash ./provision/install_water_supply.sh .
+bash ./provision/install_water_demand.sh .
 ```
 
 Run post-install scripts:

config/dimensions/water_demand_population_areas.yml

@@ -0,0 +1,3 @@
+name: water_demand_population_areas
+description: Names of water demand population areas
+elements: water_demand/water_demand_population_areas.csv

config/model_runs/water_demand_test.yml

@@ -0,0 +1,12 @@
+description: ''
+name: water_demand_test
+narratives: {}
+scenarios:
+  water_demand_populations: actual
+sos_model: water_demand_only
+stamp: '2019-03-01T00:00:00.000Z'
+timesteps:
+- 2020
+- 2030
+- 2050
+strategies: []

config/scenarios/water_demand_populations.yml

@@ -0,0 +1,14 @@
+name: water_demand_populations
+description: Population numbers for water demand
+provides:
+  - name: population
+    description: Population of GB
+    dims:
+    - water_demand_population_areas
+    dtype: int
+    unit: people
+variants:
+  - name: actual
+    description: Population of GB
+    data:
+      population: water_demand/population.csv

config/sector_models/water_demand.yml

@@ -0,0 +1,30 @@
+classname: WaterDemandWrapper
+description: Water demand model
+initial_conditions: []
+inputs:
+- name: population
+  dims:
+  - water_demand_population_areas
+  dtype: int
+  unit: people
+interventions: []
+name: water_demand
+outputs:
+- name: water_demand
+  dims:
+  - water_demand_population_areas
+  dtype: float
+  unit: ML/day
+parameters:
+- name: per_capita_water_demand
+  description: The assumed per capita demand for water
+  abs_range:
+  - 0
+  - 2.0e-5
+  exp_range:
+  - 5.0e-6
+  - 1.5e-5
+  default: default_water_demand.csv
+  dtype: float
+  unit: 'ML/person/day'
+path: models/water_demand/run.py

config/sos_models/water_demand_only.yml

@@ -0,0 +1,12 @@
+name: water_demand_only
+description: Future water demand for UK
+sector_models: # Select 1 or more of the sector models
+- water_demand
+scenarios: []    # Select 0 or more of the scenario sets
+narratives: []
+scenario_dependencies:
+- source: water_demand_populations
+  source_output: population
+  sink: water_demand
+  sink_input: population
+model_dependencies: []

data/dimensions/water_demand/water_demand_population_areas.csv

@@ -0,0 +1,4 @@
+name
+England
+Scotland
+Wales

data/parameters/default_water_demand.csv

@@ -0,0 +1,2 @@
+per_capita_water_demand
+1.0e-5

data/scenarios/water_demand/population.csv

@@ -0,0 +1,10 @@
+timestep,water_demand_population_areas,population
+2020,England,55620000
+2020,Scotland,5234000
+2020,Wales,2773000
+2030,England,58401000
+2030,Scotland,5495700
+2030,Wales,2911650
+2050,England,64241100
+2050,Scotland,6045270
+2050,Wales,3202815

models/water_demand/run.py

@@ -0,0 +1,52 @@
+"""Water demand model
+"""
+import numpy as np
+import pandas as pd
+
+from smif.model.sector_model import SectorModel
+from water_demand import WaterDemand
+
+
+class WaterDemandWrapper(SectorModel):
+    """Water Model Wrapper
+    """
+
+    def before_model_run(self, data_handle=None):
+        """Implement this method to conduct pre-model run tasks
+
+        Arguments
+        ---------
+        data_handle: smif.data_layer.DataHandle
+            Access parameter values (before any model is run, no dependency
+            input data or state is guaranteed to be available)
+
+        Info
+        -----
+        `self.user_data` allows to pass data from before_model_run to main model
+        """
+        pass
+
+    def simulate(self, data_handle):
+        """Runs the water supply model.
+
+        Arguments
+        ---------
+        data_handle : dict
+            A dictionary containing all parameters and model inputs defined in
+            the smif configuration by name
+
+        """
+
+        # The per capita demand (in ML/person/day) is set as a model parameter
+        per_capita_demand = data_handle.get_parameter('per_capita_water_demand')
+
+        # The population is currently a scenario dependency
+        pop_input = data_handle.get_data('population')
+
+        # Create the model
+        model = WaterDemand(population=pop_input.data, scale_factor=per_capita_demand.data)
+
+        # Simulate the water demand
+        demand = model.simulate()
+
+        data_handle.set_results('water_demand', demand)

provision/config.ini

@@ -60,3 +60,7 @@ model_version=6d8642567967f6168b6dc31c97043083bc644b0b
 remote_data=water_supply/data_to_prepare_nodal_v3.zip
 local_dir=models/water_supply
 dim_dir=data/dimensions/water_supply
+
+[water-demand]
+local_dir=models/water_demand
+model_version=v1.1

provision/get_install_all.sh

@@ -32,6 +32,9 @@ bash -x ./provision/install_transport.sh .
 bash -x ./provision/get_data_et_module.sh .
 bash -x ./provision/install_et_module.sh .
 
-# Water supplysmif
+# Water supply
 bash -x ./provision/get_data_water_supply.sh .
 bash -x ./provision/install_water_supply.sh .
+
+# Water demand
+bash -x ./provision/install_water_demand.sh .

provision/install_water_demand.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+# Expect NISMOD dir as first argument
+base_path=$1
+
+# Read remote_data, local_dir from config.ini
+source <(grep = <(grep -A2 "\[water-demand\]" $base_path/provision/config.ini))
+
+# Locations for the git repo (temporary) and the nodal-related files
+repo_dir=$local_dir/repo
+
+# Clone repo and copy necessary files to the model directory
+pip install git+https://github.com/nismod/water_demand.git@$model_version#egg=water_demand

provision/vm_provision.sh

@@ -222,6 +222,9 @@ bash -x $base_path/provision/install_et_module.sh $base_path
 bash -x $base_path/provision/get_data_water_supply.sh $base_path
 bash -x $base_path/provision/install_water_supply.sh $base_path
 
+# Water demand
+bash -x $base_path/provision/install_water_demand.sh $base_path
+
 
 #
 # User config