34_urban exo_nov21 Realisation PR #340

caviddhen · 2021-11-06T10:28:27Z

🐦 Purpose of this PR 🐦

Include non-static urban land as a new realization in 34_urban module: exo_nov21. Urban land in this case is exogenous based on cellular LUH2v2 SSP-based projections. In the realization, cellular urban land is highly incentivized to match the input data, while regional totals are constrained to match input data totals exactly.

🔧 Checklist for PR creator 🔧

Labeling pull request correctly from the label list.

Low risk : Simple bugfixes (missing files, updated documentation, typos) or Start/output scripts
Medium risk : New realization / Changes to existing realization / Other changes which don't modify default.cfg
High risk : New input files (if cfg$input is changed in default.cfg) / Modification to core model (eg. changes in equations, calculations, introduction of new sets etc.) / Other changes in default.cfg

Providing additional information based on PR label

Medium risk : Default run based on the current version of the fork from which PR is made

📉 Performance loss/gain from current default behavior 📈
Added changes to CHANGELOG.md
Compilation check (model starts without compilation errors - use gams main.gms action=c in model folder for testing).
No hard coded numbers and cluster/country/region names.
The new code doesn't contain declared but unused parameters or variables.
Where relevant, In-code comments added including documentation comments.
Made sure that documentation created with goxygen is okay (use goxygen::goxygen() for testing).
Changes to magpie4 R library for post processing of model output (ideally backward compatible).
Self-review of my own code.

⚠️ Additional notes or warnings ⚠️

NA

🚨 Checklist for RSE reviewer 🚨

PR is labeled correctly.
CHANGELOG is updated correctly
No hard coded numbers and cluster/country/region names.
No unnecessary increase in module interfaces
All required updates in interfaces (if any) have been properly adressed in the module contracts
In-code comments and documentation comments are satisfactory.
model behavior/performance is satisfactory.
Requested changes (if any) were applied correctly

🚨 Checklist for MAgPIE reviewer 🚨

PR is labeled correctly.
CHANGELOG is updated correctly
No hard coded numbers and cluster/country/region names.
Changes to the model are scientifically sound
In-code comments and documentation comments are satisfactory.
model behavior/performance is satisfactory.
Requested changes (if any) were applied correctly

tscheypidi · 2021-11-08T14:42:35Z

@caviddhen codeCheck failed....please fix the issue first

…o urban_ex_PR

caviddhen · 2021-11-08T15:10:34Z

@caviddhen codeCheck failed....please fix the issue first

Ah sorry, Fixed now

tscheypidi · 2021-11-09T11:31:50Z

modules/10_land/landmatrix_dec18/presolve.gms

+*' Urban land is fixed - turning off for urban land expansion  implementation
+*' v10_lu_transitions.fx(j,land_from10,"urban") = 0;
+*' v10_lu_transitions.fx(j,"urban",land_to10) = 0;
+*' v10_lu_transitions.fx(j,"urban","urban") = pcm_land(j,"urban");


two issues/questions:

using *' will make your comment a goxygen comment and it will show up in the document. Is that intended?

As this was fixed before but is not fixed anymore: This realization will still work with static urban?

Ah, I can just delete it instead?

Static urban still static. I believe this line in static realization already constrains it, the results also maintain static urban land:
https://github.com/magpiemodel/magpie/blob/rc/modules/34_urban/static/presolve.gms#L9

tscheypidi · 2021-11-09T11:34:16Z

modules/34_urban/exo_nov21/equations.gms

+*' Cost terms for when vm_land(j2,"urban") is less than and greater than the input
+
+q34_urban_cost1(j2) ..
+            v34_cost1(j2) =g= sum(ct, i34_urban_area(ct, j2)) - vm_land(j2,"urban");


Why is that required? why not just use vm_land.fx(j2,"urban") = i34_urban_area(ct,j2)?

We thought that this way safeguards against infeasible outcomes. Where urban land should expand but can not due to NPI or other protected land constraints. In this case it can have high costs and shift it elsewhere in the region.

should be added to the explanation text above

tscheypidi · 2021-11-09T11:35:47Z

modules/34_urban/exo_nov21/not_used.txt

+# |  AGPL-3.0, you are granted additional permissions described in the
+# |  MAgPIE License Exception, version 1.0 (see LICENSE file).
+# |  Contact: magpie@pik-potsdam.de
+name,type,reason


please do not add empty not_used files. Remove it, if everything is being used.

tscheypidi · 2021-11-09T11:41:47Z

CHANGELOG.md

@@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

 ## [Unreleased]

+- **34_urban** New exo_nov21 exogenous realization of urban land expansion 


This needs to put under the sub-category "added"

bodirsky

once the runtime issue is clarified and my minor comments were corrected, ready to merge!

bodirsky · 2021-11-11T08:47:32Z

config/default.cfg

@@ -1424,6 +1424,7 @@ cfg$files2export$start <- c("input/info.txt",
                            "modules/30_crop/endo_apr21/input/avl_cropland_0.5.mz",
                            "modules/50_nr_soil_budget/input/f50_NitrogenFixationRateNatural_0.5.mz",
                            "modules/50_nr_soil_budget/input/f50_AtmosphericDepositionRates_0.5.mz",
+                            "input/f34_UrbanLand_0.5.mz",


careful with large and small letters in filenames; I think this can lead to problems. I would suggest only small letters and to use _ instead

bodirsky · 2021-11-11T08:48:31Z

modules/10_land/landmatrix_dec18/input.gms

@@ -6,7 +6,7 @@
 *** |  Contact: magpie@pik-potsdam.de

 scalars
-  s10_cost_balance Artificial cost for balance variable (USD05MER per ha) / 1000000 /
+  s10_cost_balance Artificial cost for balance variable (USD05MER per ha) / 1e+06 /


maybe 1e+5 is sufficient. Not sure whether high costs are good (punishmnet) or bad (scaling9

strange name "s10_cost_balance"; shouldnt it be rather "s10_punishment_area_deviation" or something like that?

This is not one of my changes. It is just a renaming of the unit, I think it comes from Florian's branch when i cloned it.

bodirsky · 2021-11-11T08:51:38Z

modules/34_urban/exo_nov21/equations.gms

+*' Sum up cost terms with high punishment
+
+q34_urban_cell(j2) ..
+            vm_cost_urban(j2) =e= (v34_cost1(j2) + v34_cost2(j2)) * 1000000;


shouldnt the 1000000 be s10_cost_balance?

bodirsky · 2021-11-11T08:53:23Z

modules/34_urban/exo_nov21/equations.gms

+*' Cost terms for when vm_land(j2,"urban") is less than and greater than the input
+
+q34_urban_cost1(j2) ..
+            v34_cost1(j2) =g= sum(ct, i34_urban_area(ct, j2)) - vm_land(j2,"urban");


should be added to the explanation text above

bodirsky · 2021-11-11T08:53:43Z

modules/34_urban/exo_nov21/input.gms

+*** |  MAgPIE License Exception, version 1.0 (see LICENSE file).
+*** |  Contact: magpie@pik-potsdam.de
+
+table f34_UrbanLand(t_all, j, gdp_scen09)     Urban land


also here, avoid large letters in gams code

bodirsky · 2021-11-11T08:54:53Z

modules/34_urban/exo_nov21/presolve.gms

+*** |  Contact: magpie@pik-potsdam.de
+
+vm_carbon_stock.fx(j,"urban",c_pools) = 0;
+*' Biodiveristy value (BV)


bodirsky · 2021-11-11T08:56:14Z

modules/34_urban/exo_nov21/presolve.gms

+
+vm_carbon_stock.fx(j,"urban",c_pools) = 0;
+*' Biodiveristy value (BV)
+vm_bv.fx(j,"urban", potnatveg) = pcm_land(j,"urban") * fm_bii_coeff("urban",potnatveg) * fm_luh2_side_layers(j,potnatveg);


this is exisiting code, but all these biodiv variable names are quite cryptic... no idea what side-layers should mean, and bv=biodiv is not clear, and bii is also only clear to insiders...

I agree, there is room for improvement. Also the "Bending the curve" paper should be added as reference. But this should be done as part of a dedicated PR, not as part of this PR.

bodirsky · 2021-11-11T08:59:12Z

modules/34_urban/exo_nov21/realization.gms

+*' Cellular level is "flexibly" prescribed in that there is a very high punishment term for deviating from original input values.
+*' Regional sums of urban land must add be equal for both model and input.
+
+*' @limitations Urban land is exogenously prescribed and does not interact with other model dynamics.


cellular levels...
and
@limitations...
these two sentences seem to contradict each other. is it flexibel or exo prescribed?

bodirsky · 2021-11-11T09:00:00Z

modules/34_urban/module.gms

@@ -11,8 +11,9 @@
 *' (see also the other land modules: [30_crop], [31_past], [32_forestry], [35_natveg]). 
 *' It describes urban settlement areas and estimates their corresponding carbon content.
 *'
-*' @authors Jan Philipp Dietrich, Florian Humpenöder
+*' @authors Jan Philipp Dietrich, Florian Humpenöder, David Chen


i want to be part here too at the end...

flohump · 2021-11-11T09:30:19Z

modules/34_urban/exo_nov21/equations.gms

+*' Sum up cost terms with high punishment
+
+q34_urban_cell(j2) ..
+            vm_cost_urban(j2) =e= (v34_cost1(j2) + v34_cost2(j2)) * 1000000;


1000000 should be added as scalar like s34_cost_urban_deviation

David Chen and others added 10 commits November 1, 2021 11:33

test gdp start script

fc57c07

include exo_nov21 module

42fb888

update urban exo_nov21 module

9d72cd6

bugfix corrupt description

b8192b3

update urban_ex module

305bb8b

update urban_ex module

6a0a011

update urban_ex module

236c830

update urban_ex module

e456a09

update disagg and config scripts

aaca0aa

update disagg and config scripts

9bb30d0

caviddhen added enhancement New feature or request Medium risk labels Nov 6, 2021

caviddhen requested review from tscheypidi and bodirsky November 6, 2021 10:28

update disagg and config scripts

6010e14

caviddhen added 2 commits November 8, 2021 16:04

update declarations for codecheck

effaa12

Merge branch 'urban_ex_PR' of https://github.com/caviddhen/magpie int…

d32a4fb

…o urban_ex_PR

caviddhen changed the base branch from develop to rc November 9, 2021 11:11

tscheypidi requested changes Nov 9, 2021

View reviewed changes

tscheypidi reviewed Nov 9, 2021

View reviewed changes

caviddhen added 3 commits November 9, 2021 13:01

urban module PR updates

00f0194

update config file download

2c88746

update download file

70a7c08

bodirsky requested changes Nov 11, 2021

View reviewed changes

update scaling

a28c528

flohump reviewed Nov 11, 2021

View reviewed changes

caviddhen added 2 commits November 12, 2021 09:24

update urban

6ed00e6

update urban

59efc48

tscheypidi approved these changes Nov 12, 2021

View reviewed changes

caviddhen added 2 commits November 12, 2021 15:04

update equations description

441d8cd

update default urban in cfg

ec0d0dc

bodirsky approved these changes Nov 15, 2021

View reviewed changes

caviddhen merged commit c13bb99 into magpiemodel:rc Nov 15, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

34_urban exo_nov21 Realisation PR #340

34_urban exo_nov21 Realisation PR #340

caviddhen commented Nov 6, 2021 •

edited by tscheypidi

Loading

tscheypidi commented Nov 8, 2021

caviddhen commented Nov 8, 2021

tscheypidi Nov 9, 2021

caviddhen Nov 9, 2021

tscheypidi Nov 9, 2021

caviddhen Nov 9, 2021 •

edited

Loading

bodirsky Nov 11, 2021

tscheypidi Nov 9, 2021

tscheypidi Nov 9, 2021

bodirsky left a comment

bodirsky Nov 11, 2021

bodirsky Nov 11, 2021

bodirsky Nov 11, 2021

caviddhen Nov 11, 2021

bodirsky Nov 11, 2021

bodirsky Nov 11, 2021

bodirsky Nov 11, 2021

bodirsky Nov 11, 2021

bodirsky Nov 11, 2021

bodirsky Nov 11, 2021

flohump Nov 15, 2021

bodirsky Nov 11, 2021

bodirsky Nov 11, 2021

flohump Nov 11, 2021

		@@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

		## [Unreleased]

		- 34_urban New exo_nov21 exogenous realization of urban land expansion

34_urban exo_nov21 Realisation PR #340

34_urban exo_nov21 Realisation PR #340

Conversation

caviddhen commented Nov 6, 2021 • edited by tscheypidi Loading

🐦 Purpose of this PR 🐦

🔧 Checklist for PR creator 🔧

⚠️ Additional notes or warnings ⚠️

🚨 Checklist for RSE reviewer 🚨

🚨 Checklist for MAgPIE reviewer 🚨

tscheypidi commented Nov 8, 2021

caviddhen commented Nov 8, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

caviddhen Nov 9, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bodirsky left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

caviddhen commented Nov 6, 2021 •

edited by tscheypidi

Loading

caviddhen Nov 9, 2021 •

edited

Loading