Breakout regions at model interface

[Sandie1994]

Hi, please I would like to know how one can see the new regions at the model interface, after successfully using the breakout region function of the gcamdata. I have been able to follow the steps in ''gcambreakout'' online article, and the new region name automatically appeared in the GCAM_region_names.csv with ID 33. However, after running some scenarios, I expected to see at the model interface, the new region I added, but that was not the case. I hope someone can guide me on this. Thank you.

[pkyle]

The regions listed in the Model Interface are the ones in the output database, which are the ones in the input XML files. They are listed in the order that they occur in the XML files read in, which is generally USA first, then 30 regions alphabetically from Africa_Eastern to Taiwan, then Argentina and Colombia, and finally Global. Your new region, if successfully added according to the instructions we've provided, would be just above "Global" in the list of regions (second to last entry). If that didn't happen, then here are some things to check:

1. Do you see your region defined in the XML files, in gcamdata/xml? That's usually the folder that the configuration file is pointing to (from the exe directory, ../input/gcamdata/xml).
2. Is the configuration file pointing to the correct folder path, where the XML files have the new region?

[Sandie1994]

Thanks @pkyle for the feedback. Yes, I followed all the instructions successfully, and all files that were supposed to be automatically edited for my new region to appear got edited as seen in the screenshots below (The 'original' files and the new files). For now, I am using the same regions in the documentation as an example - so you can also see that Peru_Chile is a new region with ID 33.

However, I don't see the new region in the XML files and I have used the electricity_water.xml as an example in the screenshots below. At the model interface, the same 32 regions appear. On top of 'Global' I can't see the Peru_Chile.

I have also double-checked, and the configuration file points to the correct folder path where the XML files are. So, I am not sure what is causing the new region not to appear in XML files and ultimately at the model interface. Would be happy to hear more troubleshooting steps from you Sir.

[pkyle]

I'm sorry, I just realized, I think the problem is that model users can only adjust the country-to-region mapping who have purchased a site license to the IEA's World Energy Balances, and placed the file in the appropriate place within the workspace. We aren't allowed to publicly distribute the country-level energy balances; any data that we distribute has to be aggregated to GCAM's model regions and sectors first. Without having the country-level energy balance data in the repository, any attempts to assign new model regions will fail as the "pre-built data" (which prescribe the standard default GCAM regions) will be used, over-riding any attempts to make new regions. I'm surprised XML files were built at all if this is the case. Can you check whether your workspace has the following step from the user guide?
IEA_EnergyBalances_2019.csv file placed in the ./input/inst/extdata/energy

[Sandie1994]

Thanks @pkyle for the feedback. Yes, the user guide also mentions the purchase of the CEDS and IEA data. We have an institution ready to fund this work, so we are positive they will provide the funding for these CEDS and IEA data. Is it possible to send you an email directly for the right steps to follow in purchasing these files? Just want to be sure we purchased the exact required files to avoid compatibility issues later on.

Also, the energy balance file from the IEA is not present in my workspace just as you suspected.

[debibooo]

@Sandie1994 Hi, Sandie. After purchasing the IEA energy balance.cvs, did you manage to complete the breakout fuction? We would like to do something similar and would like you to share your experience? Thank a lot if you can respend to this message.