add some units to declarations, minor test adjustments

CITATION.cff

@@ -1,4 +1,4 @@
-cff-version: 1.0.3
+cff-version: 1.2.0
 message: If you use this model, please cite it as below.
 type: software
 authors:

core/declarations.gms

@@ -83,9 +83,9 @@ pm_macCost(tall,all_regi,all_enty)                   "abatement costs for all em
 pm_macStep(tall,all_regi,all_enty)                   "step number of abatement level [integer]"
 pm_macSwitch(all_enty)                               "switch to include mac option in the code"
 pm_macCostSwitch(all_enty)                           "switch to include mac costs in the code (e.g. in coupled scenarios, we want to include the costs in REMIND, but MAC effects on emissions are calculated in MAgPIE)"
-p_priceCO2(tall,all_regi)                           "carbon price [$/tC]"
-pm_priceCO2forMAC(tall,all_regi,all_enty)             "carbon price defined for MAC gases [$/tC]"
-p_priceGas(tall,all_regi)                            "gas price in [$/tCeq] for ch4gas MAC"
+p_priceCO2(tall,all_regi)                            "carbon price [$/tC]"
+pm_priceCO2forMAC(tall,all_regi,all_enty)            "carbon price defined for MAC gases [$/tC]"
+p_priceGas(tall,all_regi)                            "gas price for ch4gas MAC [$/tCeq]"
 pm_ResidualCementDemand(tall,all_regi)               "reduction in cemend demand (and thus process emissions) due to climate policy [0...1]"
 pm_CementAbatementPrice(ttot,all_regi)               "CO2 price used during calculation of cement demand reduction [$/tCO2]"
 pm_CementDemandReductionCost(tall,all_regi)          "cost of reducing cement demand [tn$2005]"

modules/30_biomass/magpie_40/declarations.gms

@@ -55,7 +55,7 @@ Positive variable
 v30_priceshift(ttot,all_regi)      "Regional translation factor that shifts emulator prices to better fit actual MAgPIE prices [-]"
 v30_pricemult(ttot,all_regi)       "Regional multiplication factor that scales emulator prices to better fit actual MAgPIE prices [-]"
 v30_multcost(ttot,all_regi)        "Cost markup factor for deviations from demand of last coupling iteration [-]"
-v30_BioPEProdTotal(ttot,all_regi)  "total domestic PE biomass production [unit: TWyr]"
+v30_BioPEProdTotal(ttot,all_regi)  "total domestic PE biomass production [TWyr]"
 ***v30_pedem_BAU(tall,all_regi,all_enty,all_enty,all_te)    "Primary energy demand imported from refernce gdx [TWa]"
 ***v30_seprod_BAU(tall,all_regi,all_enty,all_enty,all_te)   "Secondary energy production imported from reference gdx [TWa]"
 

modules/39_CCU/off/declarations.gms

@@ -13,7 +13,7 @@
 *-----------------------------------------------ESM module------------------------
 
 positive variables
-vm_co2CCUshort(ttot,all_regi,all_enty,all_enty,all_te,rlf)           "CO2 captured in CCU te that have a persistence for co2 storage shorter than 5 years. Unit GtC/a"
+vm_co2CCUshort(ttot,all_regi,all_enty,all_enty,all_te,rlf)           "CO2 captured in CCU te that have a persistence for co2 storage shorter than 5 years [GtC/a]"
 ;
 
 *** EOF ./modules/39_CCU/off/declarations.gms

modules/39_CCU/on/declarations.gms

@@ -7,13 +7,13 @@
 *** SOF ./modules/39_CCU/on/declarations.gms
 
 parameters
-p39_co2_dem(ttot,all_regi,all_enty,all_enty,all_te)					"CO2 demand of CCU technologies, unit: tC/TWa(output)"
+p39_co2_dem(ttot,all_regi,all_enty,all_enty,all_te)					"CO2 demand of CCU technologies [tC/TWa (output)]"
 ;
 
 positive variables
-vm_co2CCUshort(ttot,all_regi,all_enty,all_enty,all_te,rlf)           "CO2 captured in CCU te that have a persistence for co2 storage shorter than 5 years. Unit GtC/a"
-v39_shSynLiq(ttot,all_regi)                                        "Share of synthetic liquids in all SE liquids. Value between 0 and 1."
-v39_shSynGas(ttot,all_regi)                                          "Share of synthetic gas in all SE gases. Value between 0 and 1."
+vm_co2CCUshort(ttot,all_regi,all_enty,all_enty,all_te,rlf)           "CO2 captured in CCU te that have a persistence for co2 storage shorter than 5 years [GtC/a]"
+v39_shSynLiq(ttot,all_regi)                                        "Share of synthetic liquids in all SE liquids [0..1]"
+v39_shSynGas(ttot,all_regi)                                          "Share of synthetic gas in all SE gases [0..1]"
 ;
 
 equations

modules/45_carbonprice/NDC/datainput.gms

@@ -16,7 +16,7 @@ Scalar p45_taxCO2eqGlobal2030 "startprice in 2030 of global CO2eq taxes towards
 p45_taxCO2eqGlobal2030 = 30 * sm_D2005_2_D2017 * sm_DptCO2_2_TDpGtC;
 Scalar p45_taxCO2eqYearlyIncrease "yearly multiplicative increase of co2 tax, write 3% as 1.03 [1]" /1.0125/;
 
-Scalar p45_taxCO2eqConvergenceYear "year until which CO2eq taxes have converged globally" /2100/;
+Scalar p45_taxCO2eqConvergenceYear "year until which CO2eq taxes have converged globally [year]" /2100/;
 *** set Years for CO2eq taxes to converge after 2030
 if(cm_NDC_divergentScenario = 0,
     p45_taxCO2eqConvergenceYear = 2100;
@@ -27,46 +27,46 @@ elseif cm_NDC_divergentScenario = 2,
 );
 
 *** load NDC data
-Table f45_factorTargetyear(tall,all_regi,NDC_version,all_GDPscen) "Table for all NDC versions with multiplier for target year emissions vs 2005 emissions, as weighted average for all countries with quantifyable emissions under NDC in particular region"
+Table f45_factorTargetyear(tall,all_regi,NDC_version,all_GDPscen) "Table for all NDC versions with multiplier for target year emissions vs 2005 emissions, as weighted average for all countries with quantifyable emissions under NDC in particular region [1]"
 $offlisting
 $ondelim
 $include "./modules/45_carbonprice/NDC/input/fm_factorTargetyear.cs3r"
 $offdelim
 $onlisting
 ;
 
-Parameter p45_factorTargetyear(ttot,all_regi) "Multiplier for target year emissions vs 2005 emissions, as weighted average for all countries with quantifyable emissions under NDC in particular region";
+Parameter p45_factorTargetyear(ttot,all_regi) "Multiplier for target year emissions vs 2005 emissions, as weighted average for all countries with quantifyable emissions under NDC in particular region [1]";
 p45_factorTargetyear(t,all_regi) = f45_factorTargetyear(t,all_regi,"%cm_NDC_version%","%cm_GDPscen%");
 
 display p45_factorTargetyear;
 
-Table f45_2005shareTarget(tall,all_regi,NDC_version,all_GDPscen) "Table for all NDC versions with 2005 GHG emission share of countries with quantifyable emissions under NDC in particular region, time dimension specifies alternative future target years"
+Table f45_2005shareTarget(tall,all_regi,NDC_version,all_GDPscen) "Table for all NDC versions with 2005 GHG emission share of countries with quantifyable emissions under NDC in particular region, time dimension specifies alternative future target years [0..1]"
 $offlisting
 $ondelim
 $include "./modules/45_carbonprice/NDC/input/fm_2005shareTarget.cs3r"
 $offdelim
 $onlisting
 ;
 
-Parameter p45_2005shareTarget(ttot,all_regi) "2005 GHG emission share of countries with quantifyable emissions under NDC in particular region, time dimension specifies alternative future target years";
+Parameter p45_2005shareTarget(ttot,all_regi) "2005 GHG emission share of countries with quantifyable emissions under NDC in particular region, time dimension specifies alternative future target years [0..1]";
 p45_2005shareTarget(t,all_regi) = f45_2005shareTarget(t,all_regi,"%cm_NDC_version%","%cm_GDPscen%");
 
 display p45_2005shareTarget;
 
-Table f45_histShare(tall,all_regi,NDC_version) "Table for all NDC versions with GHG emissions share of countries with quantifyable 2030 target, time dimension specifies historic record"
+Table f45_histShare(tall,all_regi,NDC_version) "Table for all NDC versions with GHG emissions share of countries with quantifyable 2030 target, time dimension specifies historic record [0..1]"
 $offlisting
 $ondelim
 $include "./modules/45_carbonprice/NDC/input/fm_histShare.cs3r"
 $offdelim
 $onlisting
 ;
 
-Parameter p45_histShare(tall,all_regi) "GHG emissions share of countries with quantifyable 2030 target, time dimension specifies historic record";
+Parameter p45_histShare(tall,all_regi) "GHG emissions share of countries with quantifyable 2030 target, time dimension specifies historic record [0..1]";
 p45_histShare(tall,all_regi) = f45_histShare(tall,all_regi,"%cm_NDC_version%");
 
 display p45_histShare;
 
-Parameter p45_BAU_reg_emi_wo_LU_bunkers(ttot,all_regi) "regional GHG emissions (without LU and bunkers) in BAU scenario"
+Parameter p45_BAU_reg_emi_wo_LU_bunkers(ttot,all_regi) "regional GHG emissions (without LU and bunkers) in BAU scenario [MtCO2eq/yr]"
   /
 $ondelim
 $ifthen exist "./modules/45_carbonprice/NDC/input/pm_BAU_reg_emi_wo_LU_bunkers.cs4r"
@@ -76,16 +76,16 @@ $offdelim
   /             ;
 
 *** parameters for selecting NDC years
-Scalar p45_ignoreNDCbefore          "NDC targets before this years are ignored, for example to exclude 2030 targets" /2024/;
+Scalar p45_ignoreNDCbefore          "NDC targets before this years are ignored, for example to exclude 2030 targets [year]" /2024/;
 p45_ignoreNDCbefore = max(p45_ignoreNDCbefore, cm_startyear)
-Scalar p45_ignoreNDCafter           "NDC targets after  this years are ignored, for example to exclude 2050 net zero targets" /2030/;
-Scalar p45_minRatioOfCoverageToMax  "only targets whose coverage is this times p45_bestNDCcoverage are considered. Use 1 for only best." /1.0/;
-Scalar p45_useSingleYearCloseTo     "if 0: use all. If > 0: use only one single NDC target per country closest to this year (use 2030.4 to prefer 2030 over 2035 over 2025)" /2030.4/;
+Scalar p45_ignoreNDCafter           "NDC targets after  this years are ignored, for example to exclude 2050 net zero targets [year]" /2030/;
+Scalar p45_minRatioOfCoverageToMax  "only targets whose coverage is this times p45_bestNDCcoverage are considered. Use 1 for only best [0..1]" /1.0/;
+Scalar p45_useSingleYearCloseTo     "if 0: use all. If > 0: use only one single NDC target per country closest to this year (use 2030.4 to prefer 2030 over 2035 over 2025) [year]" /2030.4/;
 
 Set p45_NDCyearSet(ttot,all_regi)                 "YES for years whose NDC targets is used";
-Parameter p45_bestNDCcoverage(all_regi)        "highest coverage of NDC targets within region";
-Parameter p45_distanceToOptyear(ttot,all_regi)    "distance to p45_useSingleYearCloseTo to favor years in case of multiple equally good targets";
-Parameter p45_minDistanceToOptyear(all_regi)   "minimal distance to p45_useSingleYearCloseTo per region";
+Parameter p45_bestNDCcoverage(all_regi)        "highest coverage of NDC targets within region [0..1]";
+Parameter p45_distanceToOptyear(ttot,all_regi)    "distance to p45_useSingleYearCloseTo to favor years in case of multiple equally good targets [year]";
+Parameter p45_minDistanceToOptyear(all_regi)   "minimal distance to p45_useSingleYearCloseTo per region [year]";
 
 p45_bestNDCcoverage(regi) = smax(t$(t.val <= p45_ignoreNDCafter AND t.val >= p45_ignoreNDCbefore), p45_2005shareTarget(t,regi));
 display p45_bestNDCcoverage;
@@ -99,9 +99,9 @@ if(p45_useSingleYearCloseTo > 0,
 );
 
 *** first and last NDC year as a number
-Parameter p45_firstNDCyear(all_regi) "last year with NDC coverage within region";
+Parameter p45_firstNDCyear(all_regi) "last year with NDC coverage within region [year]";
 p45_firstNDCyear(regi) = smin( p45_NDCyearSet(t, regi), t.val );
-Parameter p45_lastNDCyear(all_regi)  "last year with NDC coverage within region";
+Parameter p45_lastNDCyear(all_regi)  "last year with NDC coverage within region [year]";
 p45_lastNDCyear(regi)  = smax( p45_NDCyearSet(t, regi), t.val );
 
 display p45_NDCyearSet,p45_firstNDCyear,p45_lastNDCyear;

modules/45_carbonprice/NDC/declarations.gms

@@ -7,20 +7,20 @@
 *** SOF ./modules/45_carbonprice/NDC/declarations.gms
 
 Parameter
-p45_CO2eqwoLU_actual(ttot,all_regi)                      "actual level of regional GHG emissions after previous iteration"
-p45_CO2eqwoLU_goal(ttot,all_regi)                        "regional NDC target level of GHG emissions"
-p45_factorRescaleCO2Tax(ttot,all_regi)                   "multiplicative factor to rescale CO2 taxes to achieve the climate targets"
-p45_factorRescaleCO2TaxLtd(ttot,all_regi)                "multiplicative factor to rescale CO2 taxes to achieve the climate targets limited to not-so-fast adaption"
-p45_factorRescaleCO2Tax_iter(iteration,ttot,all_regi)    "Track the changes of p45_factorRescaleCO2Tax over the iterations"
-p45_factorRescaleCO2TaxLtd_iter(iteration,ttot,all_regi) "Track the changes of p45_factorRescaleCO2TaxLimited over the iterations"
-p45_taxCO2eqFirstNDCyear(all_regi)                       "CO2eq tax in p45_firstNDCyear"
-p45_taxCO2eqLastNDCyear(all_regi)                        "CO2eq tax in p45_lastNDCyear"
-p45_CO2eqwoLU_actual_iter(iteration,ttot,all_regi)       "actual level of regional GHG emissions p45_CO2eqwoLU_actual tracked over iterations"
-p45_taxCO2eq_iter(iteration,ttot,all_regi)               "CO2eq tax non-regi tracked over iterations"
-p45_taxCO2eq_bau(ttot,all_regi)                          "level of CO2 taxes in business as usual run"
+p45_CO2eqwoLU_actual(ttot,all_regi)                      "actual level of regional GHG emissions after previous iteration [MtCO2eq/yr]"
+p45_CO2eqwoLU_goal(ttot,all_regi)                        "regional NDC target level of GHG emissions [MtCO2eq/yr]"
+p45_CO2eqwoLU_actual_iter(iteration,ttot,all_regi)       "actual level of regional GHG emissions p45_CO2eqwoLU_actual tracked over iterations [MtCO2eq/yr]"
+p45_factorRescaleCO2Tax(ttot,all_regi)                   "multiplicative factor to rescale CO2 taxes to achieve the climate targets [1]"
+p45_factorRescaleCO2TaxLtd(ttot,all_regi)                "multiplicative factor to rescale CO2 taxes to achieve the climate targets limited to not-so-fast adaption [1]"
+p45_factorRescaleCO2Tax_iter(iteration,ttot,all_regi)    "Track the changes of p45_factorRescaleCO2Tax over the iterations [1]"
+p45_factorRescaleCO2TaxLtd_iter(iteration,ttot,all_regi) "Track the changes of p45_factorRescaleCO2TaxLimited over the iterations [1]"
+p45_taxCO2eqFirstNDCyear(all_regi)                       "CO2eq tax in p45_firstNDCyear [T$/GtC]"
+p45_taxCO2eqLastNDCyear(all_regi)                        "CO2eq tax in p45_lastNDCyear [T$/GtC]"
+p45_taxCO2eq_iter(iteration,ttot,all_regi)               "CO2eq tax non-regi tracked over iterations [T$/GtC]"
+p45_taxCO2eq_bau(ttot,all_regi)                          "level of CO2 taxes in business as usual run [T$/GtC]"
 ;
 
-Scalar    p45_adjustExponent                             "exponent in tax adjustment process";
+Scalar    p45_adjustExponent                             "exponent in tax adjustment process [1]";
 
 
 *** EOF ./modules/45_carbonprice/NDC/declarations.gms

modules/45_carbonprice/exogenous/declarations.gms

@@ -6,7 +6,7 @@
 *** |  Contact: remind@pik-potsdam.de
 *** SOF ./modules/45_carbonprice/exogenous/declarations.gms
 parameters
-    p45_tau_co2_tax(ttot,all_regi)   "Exogenous CO2 tax level"
+    p45_tau_co2_tax(ttot,all_regi)   "Exogenous CO2 tax level [T$/GtC]"
 ;
 
 *** EOF ./modules/45_carbonprice/exogenous/declarations.gms

modules/45_carbonprice/expoLinear/declarations.gms

@@ -7,10 +7,10 @@
 *** SOF ./modules/45_carbonprice/expoLinear/declarations.gms
 
 scalar
-s45_co2_tax_startyear                       "level of CO2 tax in start year in T$/GtC"
+s45_co2_tax_startyear                       "level of CO2 tax in start year [T$/GtC]"
 ;
 parameter
-p45_tau_co2_tax_inc(all_regi)     "Linear annual increase in carbon price T$/GtC/yr"
+p45_tau_co2_tax_inc(all_regi)     "Linear annual increase in carbon price [T$/GtC/yr]"
 ;
 
 *** EOF ./modules/45_carbonprice/expoLinear/declarations.gms