Update material module documentation

doc/material/index.rst

@@ -70,13 +70,13 @@ The mode option `--mode` has two different inputs 'by_url' (by default) or 'by_c
 The first one uses the provided url to add the materials implementation on top of the scenario from the url.
 This is the default option. The latter is used to create a 2 degree mitigation scenario with materials by copying carbon prices to the scenario that is specified by `--scenario_name`::
 
-    mix-models material-ix build --tag test --mode by_copy --scenario_name \
-        baseline_DEFAULT_test
+    mix-models --url="ixmp://ixmp_dev/MESSAGEix-Materials/scenario_name" material-ix \
+     build --tag test --mode by_copy
 
 This command line only builds the scenario but does not solve it. To solve the scenario, use ``mix-models materials-ix solve``, giving the scenario name, e.g.::
 
-    mix-models material-ix SSP2 solve --scenario_name baseline_DEFAULT_test \
-        --add_calibration False --add_macro False
+    mix-models --url="ixmp://ixmp_dev/MESSAGEix-Materials/scenario_name" material-ix \
+     SSP2 solve --add_calibration False --add_macro False
 
 The solve command has the `--add_calibration` option to add MACRO calibration to a baseline scenario. `--add_macro` option solves the scenario with MACRO.
 Both options are False by default.To first calibrate the scenario and then solve that scenario with MACRO both options should be set to True.
@@ -86,7 +86,7 @@ Reporting
 
 The reporting generates specific variables related to materials, mainly Production and Final Energy.
 The resulting reporting file is generated under message_ix_models\\data\\material\\reporting_output with the name “New_Reporting_MESSAGEix-Materials_scenario_name.xlsx”.
-More detailed variables related to the whole energy system and emissions are not inlcuded in this reporting.
+More detailed variables related to the whole energy system and emissions are not included in this reporting.
 
 Reporting is executed by the following command::
 
@@ -134,7 +134,7 @@ The code relies on the following input files, stored in :file:`data/material/`:
   Final energy values to calibrate base year values for industries
 
 :file:`residual_industry_2019.xlsx`
-  Final energy values to calculate the residual industry demand.
+  Final energy values to calculate the residual industry demand
 
 :file:`nh3_fertilizer_demand.xlsx`
   Nitrogen fertilizer demand
@@ -143,7 +143,7 @@ The code relies on the following input files, stored in :file:`data/material/`:
   Techno-economic parameters for NH3 production technologies
 
 :file:`cost_conv_nh3.xlsx`
-  Cost convergance parameters for NH3 produciton technologies
+  Regional cost convergence settings for NH3 production technologies over time
 
 :file:`methanol demand.xlsx`
   Methanol demand
@@ -155,13 +155,13 @@ The code relies on the following input files, stored in :file:`data/material/`:
   Techno-economic parameters for methanol production technologies
 
 :file:`petrochemicals_techno_economic.xls`
-  Techno-economic parameters for refinery and high value chemicals production technologies
+  Techno-economic parameters for refinery and high-value chemicals production technologies
 
 :file:`steam_cracking_hist_act.csv`
-  Steam cracker historical activities
+  Steam cracker historical activities in R12 regions
 
 :file:`steam_cracking_hist_new_cap.csv`
-  Steam cracker historical capacities
+  Steam cracker historical capacities in R12 regions
 
 :file:`NTNU_LCA_coefficients.xlsx`
    Material intensity (and other) coefficients for power plants based on lifecycle assessment (LCA) data from the THEMIS database, compiled in the `ADVANCE project <http://www.fp7-advance.eu/?q=content/environmental-impacts-module>`_.
@@ -176,10 +176,50 @@ The code relies on the following input files, stored in :file:`data/material/`:
    Commodity mapping (for materials) of global 11-regional MESSAGEix-GLOBIOM model to commodities of THEMIS LCA dataset.
 
 :file:`SSP_UE_dyn_input.xlsx`
-   Calibration of end-use energy demands
+   Calibration file for industry end-use energy demands
+
+:file:`SSP_UE_dyn_input_all.xlsx`
+   Calibration file for end-use energy demands
+
+:file:`iea_mappings/all_technologies.csv`
+   Mapping of MESSAGEix-GLOBIOM technologies to IEA EWEB flows and products
+
+:file:`iea_mappings/chemicals.csv`
+   Mapping of MESSAGEix-GLOBIOM industry technologies to IEA EWEB products of chemical sector flows
+
+:file:`iea_mappings/industry.csv`
+   Mapping of MESSAGEix-GLOBIOM industry technologies to IEA EWEB products of industry sector flows not covered by MESSAGEix-Materials
+
+:file:`ammonia/demand_NH3.yaml`
+   Ammonia demand in each R12 region in year 2020
+
+:file:`other/mer_to_ppp_default.csv`
+   Default conversion factors for GDP MER to PPP used in MESSAGEix-GLOBIOM SSP2 scenarios.
+   Used to create demand projections for steel/cement/aluminum/chemicals if GDP_PPP data is not in scenario
+
+:file:`buildings/LED_LED_report_IAMC_sensitivity_R12.csv`
+   Data from MESSAGEix-Buidings LED scenarios used to get steel/cement/aluminum demands from buildings
+
+:file:`buildings/report_IRP_SSP2_BL_comm_R12.csv`
+   Commerical sector data from MESSAGEix-Buidings used to get steel/cement/aluminum demands from buildings
+
+:file:`buildings/report_IRP_SSP2_BL_resid_R12.csv`
+   Residential sector data from MESSAGEix-Buidings used to get steel/cement/aluminum demands from buildings
+
+:file:`/methanol/results_material_SHAPE_comm.csv`
+   Commercial sector data from MESSAGEix-Buidings SHAPE scenario used to get wood demands from buildings to estimate resin demands
+
+:file:`/methanol/results_material_SHAPE_resid.csv`
+   Residential sector data from MESSAGEix-Buidings SHAPE scenario used to get wood demands from buildings to estimate resin demands
+
+:file:`/methanol/results_material_SSP2_comm.csv`
+   Commercial sector data from MESSAGEix-Buidings SSP2 scenario used to get wood demands from buildings to estimate resin demands
+
+:file:`/methanol/results_material_SSP2_resid.csv`
+   Residential sector data from MESSAGEix-Buidings SSP2 scenario used to get wood demands from buildings to estimate resin demands
 
 :file:`material/set.yaml`
 ----------------------------
 
-.. literalinclude:: ../../../data/material/set.yaml
+.. literalinclude:: ../../message_ix_models/data/material/set.yaml
    :language: yaml