feat: existing electricity mixes

app.py

@@ -1,7 +1,8 @@
-from typing import Optional
 import gradio as gr
 from pint import UnitRegistry
 
+from data.mixes import MIXES, find_mix
+
 from ecologits.tracers.utils import compute_llm_impacts, _avg
 from ecologits.impacts.llm import compute_llm_impacts as compute_llm_impacts_expert
 from ecologits.impacts.llm import IF_ELECTRICITY_MIX_GWP, IF_ELECTRICITY_MIX_ADPE, IF_ELECTRICITY_MIX_PE
@@ -48,7 +49,6 @@ MODELS = [
     ("Cohere / Command R+", "cohere/command-r-plus"),
 ]
 
-
 PROMPTS = [
     ("Write a Tweet", 50),
     ("Write an email", 170),
@@ -146,6 +146,11 @@ def model_total_params_fn(model_name: str, n_param: float):
     model = models.find_model(provider=provider, model_name=model_name)
     return model.total_parameters or _avg(model.total_parameters_range)
 
+def mix_fn(country_code: str, mix_adpe: float, mix_pe: float, mix_gwp: float):
+    if country_code == CUSTOM:
+        return mix_gwp, mix_adpe, mix_pe
+    return find_mix(country_code)
+
 with gr.Blocks() as demo:
 
 ### TITLE
@@ -244,18 +249,34 @@ with gr.Blocks() as demo:
             label="Output tokens", 
             value=100
         )
-        mix_gwp = gr.Number(
-            label="Electricity mix - GHG emissions [kgCO2eq / kWh]",
-            value=IF_ELECTRICITY_MIX_GWP
+
+        mix = gr.Dropdown(
+            MIXES + [CUSTOM], 
+            label="Location",
+            value="WOR", 
+            filterable=True,
+            interactive=True
         )
         mix_adpe = gr.Number(
             label="Electricity mix - Abiotic resources [kgSbeq / kWh]",
-            value=IF_ELECTRICITY_MIX_ADPE
+            value=IF_ELECTRICITY_MIX_ADPE, 
+            interactive=True
         )
         mix_pe = gr.Number(
             label="Electricity mix - Primary energy [MJ / kWh]",
-            value=IF_ELECTRICITY_MIX_PE
+            value=IF_ELECTRICITY_MIX_PE, 
+            interactive=True
+        )
+        mix_gwp = gr.Number(
+            label="Electricity mix - GHG emissions [kgCO2eq / kWh]",
+            value=IF_ELECTRICITY_MIX_GWP, 
+            interactive=True
         )
+
+        mix.change(fn=mix_fn, inputs=[mix, mix_adpe, mix_pe, mix_gwp], outputs=[mix_adpe, mix_pe, mix_gwp])
+        mix_adpe.input(fn=custom, outputs=mix)
+        mix_pe.input(fn=custom, outputs=mix)
+        mix_gwp.input(fn=custom, outputs=mix)
         
         with gr.Row():
             energy = gr.Markdown(
@@ -314,7 +335,9 @@ with gr.Blocks() as demo:
 
 ### METHOD QUICK EXPLANATION
     with gr.Tab('Methodology'):
-        gr.Markdown("""📖 Coming soon""")
+        gr.Markdown("""## 📖 Methodology
+        🚧 Under construction
+        """)
 
 ### INFORMATION ABOUT INDICATORS
     with gr.Accordion("📊 More about the indicators", open = False):

data/electricity_mix.csv

@@ -0,0 +1,4 @@
+name,unit,source,WOR,EEE,ZWE,ZMB,ZAF,YEM,VNM,VEN,UZB,URY,USA,UKR,TZA,TWN,TTO,TUR,TUN,TKM,TJK,THA,TGO,SYR,SLV,SEN,SVK,SVN,SGP,SWE,SDN,SAU,RUS,SCG,ROU,QAT,PRY,PRT,POL,PAK,PHL,PER,PAN,OMN,NZL,NPL,NOR,NLD,NIC,NGA,NAM,MOZ,MYS,MEX,MLT,MNG,MMR,MKD,MDA,MAR,LBY,LVA,LUX,LTU,LKA,LBN,KAZ,KWT,KOR,PRK,KHM,KGZ,KEN,JPN,JOR,JAM,ITA,ISL,IRN,IRQ,IND,ISR,IRL,IDN,HUN,HTI,HRV,HND,HKG,GTM,GRC,GIB,GHA,GEO,GBR,GAB,FRA,FIN,ETH,ESP,ERI,EGY,EST,ECU,DZA,DOM,DNK,DEU,CZE,CYP,CUB,CRI,COL,CHN,CMR,CHL,CIV,CHE,COG,COD,CAN,BLR,BWA,BRA,BOL,BRN,BEN,BHR,BGR,BEL,BGD,BIH,AZE,AUS,AUT,ARG,AGO,ANT,ARM,ALB,ARE
+adpe,kg éq. Sb,ADEME Base IMPACTS ®,0.0000000737708,0.0000000642317,0.000000109502,0.000000162193,0.0000000862445,0.0000000163908,0.0000000945573,0.000000112811,0.000000103681,0.000000104586,0.0000000985548,0.0000000647907,0.000000132261,0.0000000578088,0.000000064552,0.0000000749765,0.0000000177021,0.000000131822,0.000000152621,0.0000000569593,0.000000134255,0.0000000268396,0.0000000472135,0.0000000470662,0.0000000606109,0.0000000992283,0.0000000198459,0.0000000777062,0.0000000955701,0.0000000134206,0.0000000960312,0.000000132772,0.0000000981761,0.00000001324,0.000000149181,0.0000000341863,0.000000101946,0.0000000842952,0.0000000595304,0.0000000952688,0.0000000790553,0.0000000374073,0.0000000720474,0.000000238273,0.000000127486,0.0000000329318,0.0000000414983,0.0000000621,0.000000128285,0.000000148382,0.000000044938,0.0000000578358,0.000000049475,0.000000176361,0.000000152699,0.000000119873,0.000000110674,0.0000000641089,0.0000000206592,0.000000153757,0.000000105692,0.0000000294596,0.0000000986932,0.0000000182134,0.000000135386,0.0000000141168,0.0000000518017,0.000000117457,0.0000000319202,0.000000181827,0.0000000958533,0.0000000596578,0.0000000147031,0.0000000196047,0.00000005439,0.0000000781905,0.0000000220304,0.0000000404306,0.000000100099,0.0000000610194,0.0000000219257,0.0000000610451,0.0000000644587,0.0000000937057,0.000000153989,0.0000000649373,0.0000000816213,0.0000000803251,0.0000000691645,0.0000000286211,0.000000156003,0.000000137999,0.0000000370973,0.000000113843,0.0000000485798,0.0000000805114,0.000000174161,0.0000000518326,0.0000000512406,0.000000033925,0.0000000990171,0.000000127168,0.0000000216438,0.0000000429285,0.0000000157411,0.0000000878733,0.0000000817565,0.0000000448771,0.0000000299542,0.0000000863908,0.000000122031,0.0000000851552,0.000000146313,0.000000105851,0.0000000949004,0.000000100467,0.000000265575,0.000000174647,0.0000000993179,0.0000000840478,0.0000000866014,0.00000010962,0.0000000969793,0.0000000185641,0.0000000239702,0.0000000135014,0.0000000823611,0.0000000337201,0.0000000394158,0.000000148007,0.000000092567,0.0000000790846,0.000000141124,0.0000000768612,0.000000124074,0.0000000449103,0.0000000854245,0.000000229556,0.0000000141548
+pe,MJ,ADPf / (1-%renewable_energy),9.988,12.873,16.122,1.798,11.732,16.250,11.238,15.163,17.367,107.570,11.358,12.936,9.305,11.439,14.289,16.150,12.902,23.300,19.165,10.414,21.978,16.989,13.012,14.516,11.680,12.146,10.477,11.026,29.629,14.058,13.200,14.242,15.585,11.916,0.020,14.153,13.178,16.175,11.120,8.211,16.364,22.306,24.731,0.396,4.952,8.511,24.696,11.279,468.150,0.206,12.268,11.775,19.374,15.114,14.132,19.120,18.429,11.702,19.116,8.249,10.128,21.043,12.116,12.341,13.260,12.753,10.199,32.793,34.655,15.380,68.996,10.718,13.677,14.799,12.656,0.013,15.022,20.372,20.363,10.023,10.706,11.603,11.784,20.167,18.548,15.762,,14.340,14.487,,10.097,10.425,13.579,28.341,11.289,11.275,36.133,12.090,13.289,10.195,16.334,20.908,16.376,12.412,16.824,16.260,12.517,13.118,17.317,45.996,7.312,14.119,10.807,11.348,14.783,11.782,34.147,0.097,11.987,13.194,19.642,9.031,11.587,15.689,14.337,14.036,14.375,10.776,12.935,21.705,12.831,16.908,11.036,10.049,16.972,,13.380,0.201,19.032
+gwp,kg éq. CO2,ADEME Base IMPACTS ®,0.590478,0.509427,0.842811,0.0141304,1.17562,1.06777,0.555572,0.497373,0.81178,0.296953,0.67978,0.646745,0.475635,0.845351,0.933059,0.706988,0.80722,1.38296,0.0426743,0.646174,0.545455,1.08778,0.473128,1.1195,0.309341,0.498523,0.655825,0.0464664,1.12472,0.913677,0.66131,1.07808,0.664245,0.722125,0.241601,0.571172,1.15075,0.748727,0.761317,0.284364,0.53403,1.41292,0.293397,0.0841323,0.023754,0.544803,0.941626,0.693123,0.357253,0.00880732,0.832206,0.739214,1.31149,1.47192,0.48193,1.24074,1.04213,0.933694,1.35361,0.234273,0.490016,0.154229,0.709185,0.883627,1.128,0.885084,0.599585,0.797361,1.41054,0.156039,0.589603,0.540891,0.781372,1.07345,0.621329,0.0194609,0.930385,1.48728,1.58299,0.901842,0.648118,0.875394,0.541558,1.3858,0.535759,0.692837,0.95888,0.645801,1.13127,0.977477,0.540126,0.132046,0.602137,0.732511,0.0813225,0.322068,0.251299,0.467803,1.13153,0.587775,1.51492,0.627714,1.02318,0.909252,0.633534,0.657374,0.799077,0.978041,1.28325,0.224471,0.214014,1.05738,0.456622,0.574415,0.928583,0.0448568,0.904053,0.0613102,0.238191,0.795697,2.12572,0.278647,0.585131,0.997577,1.19128,0.804567,0.827087,0.256537,0.795168,1.56025,0.726126,1.12326,0.245573,0.476811,0.412014,1.13161,0.252002,0.0207635,1.09088

data/mixes.py

@@ -0,0 +1,154 @@
+from csv import DictReader
+
+PATH = "data/electricity_mix.csv"
+MIXES = [
+    ("🌎 World", "WOR"),
+    ("🇪🇺 Europe", "EEE"),
+    ("🇿🇼 Zimbabwe", "ZWE"),
+    ("🇿🇲 Zambia", "ZMB"),
+    ("🇿🇦 South Africa", "ZAF"),
+    ("🇾🇪 Yemen", "YEM"),
+    ("🇻🇳 Vietnam", "VNM"),
+    ("🇻🇪 Venezuela", "VEN"),
+    ("🇺🇿 Uzbekistan", "UZB"),
+    ("🇺🇾 Uruguay", "URY"),
+    ("🇺🇸 United States", "USA"),
+    ("🇺🇦 Ukraine", "UKR"),
+    ("🇹🇿 Tanzania", "TZA"),
+    ("🇹🇼 Taiwan", "TWN"),
+    ("🇹🇹 Trinidad and Tobago", "TTO"),
+    ("🇹🇷 Turkey", "TUR"),
+    ("🇹🇳 Tunisia", "TUN"),
+    ("🇹🇲 Turkmenistan", "TKM"),
+    ("🇹🇯 Tajikistan", "TJK"),
+    ("🇹🇭 Thailand", "THA"),
+    ("🇹🇬 Togo", "TGO"),
+    ("🇸🇾 Syrian Arab Republic", "SYR"),
+    ("🇸🇻 El Salvador", "SLV"),
+    ("🇸🇳 Senegal", "SEN"),
+    ("🇸🇰 Slovak Republic", "SVK"),
+    ("🇸🇮 Slovenia", "SVN"),
+    ("🇸🇬 Singapore", "SGP"),
+    ("🇸🇪 Sweden", "SWE"),
+    ("🇸🇩 Sudan", "SDN"),
+    ("🇸🇦 Saudi Arabia", "SAU"),
+    ("🇷🇺 Russian Federation", "RUS"),
+    ("🇷🇸 Serbia and Montenegro", "SCG"),
+    ("🇷🇴 Romania", "ROU"),
+    ("🇶🇦 Qatar", "QAT"),
+    ("🇵🇾 Paraguay", "PRY"),
+    ("🇵🇹 Portugal", "PRT"),
+    ("🇵🇱 Poland", "POL"),
+    ("🇵🇰 Pakistan", "PAK"),
+    ("🇵🇭 Philippines", "PHL"),
+    ("🇵🇪 Peru", "PER"),
+    ("🇵🇦 Panama", "PAN"),
+    ("🇴🇲 Oman", "OMN"),
+    ("🇳🇿 New Zealand", "NZL"),
+    ("🇳🇵 Nepal", "NPL"),
+    ("🇳🇴 Norway", "NOR"),
+    ("🇳🇱 Netherlands", "NLD"),
+    ("🇳🇮 Nicaragua", "NIC"),
+    ("🇳🇬 Nigeria", "NGA"),
+    ("🇳🇦 Namibia", "NAM"),
+    ("🇲🇿 Mozambique", "MOZ"),
+    ("🇲🇾 Malaysia", "MYS"),
+    ("🇲🇽 Mexico", "MEX"),
+    ("🇲🇹 Malta", "MLT"),
+    ("🇲🇳 Mongolia", "MNG"),
+    ("🇲🇲 Myanmar", "MMR"),
+    ("🇲🇰 North Macedonia", "MKD"),
+    ("🇲🇩 Moldova", "MDA"),
+    ("🇲🇦 Morocco", "MAR"),
+    ("🇱🇾 Libya", "LBY"),
+    ("🇱🇻 Latvia", "LVA"),
+    ("🇱🇺 Luxembourg", "LUX"),
+    ("🇱🇹 Lithuania", "LTU"),
+    ("🇱🇰 Sri Lanka", "LKA"),
+    ("🇱🇧 Lebanon", "LBN"),
+    ("🇰🇿 Kazakhstan", "KAZ"),
+    ("🇰🇼 Kuwait", "KWT"),
+    ("🇰🇷 South Korea", "KOR"),
+    ("🇰🇵 North Korea", "PRK"),
+    ("🇰🇭 Cambodia", "KHM"),
+    ("🇰🇬 Kyrgyz Republic", "KGZ"),
+    ("🇰🇪 Kenya", "KEN"),
+    ("🇯🇵 Japan", "JPN"),
+    ("🇯🇴 Jordan", "JOR"),
+    ("🇯🇲 Jamaica", "JAM"),
+    ("🇮🇹 Italy", "ITA"),
+    ("🇮🇸 Iceland", "ISL"),
+    ("🇮🇷 Iran", "IRN"),
+    ("🇮🇶 Iraq", "IRQ"),
+    ("🇮🇳 India", "IND"),
+    ("🇮🇱 Israel", "ISR"),
+    ("🇮🇪 Ireland", "IRL"),
+    ("🇮🇩 Indonesia", "IDN"),
+    ("🇭🇺 Hungary", "HUN"),
+    ("🇭🇹 Haiti", "HTI"),
+    ("🇭🇷 Croatia", "HRV"),
+    ("🇭🇳 Honduras", "HND"),
+    ("🇭🇰 Hong Kong", "HKG"),
+    ("🇬🇹 Guatemala", "GTM"),
+    ("🇬🇷 Greece", "GRC"),
+    ("🇬🇮 Gibraltar", "GIB"),
+    ("🇬🇭 Ghana", "GHA"),
+    ("🇬🇪 Georgia", "GEO"),
+    ("🇬🇧 United Kingdom", "GBR"),
+    ("🇬🇦 Gabon", "GAB"),
+    ("🇫🇷 France", "FRA"),
+    ("🇫🇮 Finland", "FIN"),
+    ("🇪🇹 Ethiopia", "ETH"),
+    ("🇪🇸 Spain", "ESP"),
+    ("🇪🇷 Eritrea", "ERI"),
+    ("🇪🇬 Egypt", "EGY"),
+    ("🇪🇪 Estonia", "EST"),
+    ("🇪🇨 Ecuador", "ECU"),
+    ("🇩🇿 Algeria", "DZA"),
+    ("🇩🇴 Dominican Republic", "DOM"),
+    ("🇩🇰 Denmark", "DNK"),
+    ("🇩🇪 Germany", "DEU"),
+    ("🇨🇿 Czech Republic", "CZE"),
+    ("🇨🇾 Cyprus", "CYP"),
+    ("🇨🇺 Cuba", "CUB"),
+    ("🇨🇷 Costa Rica", "CRI"),
+    ("🇨🇴 Colombia", "COL"),
+    ("🇨🇳 China", "CHN"),
+    ("🇨🇲 Cameroon", "CMR"),
+    ("🇨🇱 Chile", "CHL"),
+    ("🇨🇮 Cote d'Ivoire", "CIV"),
+    ("🇨🇭 Switzerland", "CHE"),
+    ("🇨🇬 Congo", "COG"),
+    ("🇨🇩 Democratic Republic of the Congo", "COD"),
+    ("🇨🇦 Canada", "CAN"),
+    ("🇧🇾 Belarus", "BLR"),
+    ("🇧🇼 Botswana", "BWA"),
+    ("🇧🇷 Brazil", "BRA"),
+    ("🇧🇴 Bolivia", "BOL"),
+    ("🇧🇳 Brunei", "BRN"),
+    ("🇧🇯 Benin", "BEN"),
+    ("🇧🇭 Bahrain", "BHR"),
+    ("🇧🇬 Bulgaria", "BGR"),
+    ("🇧🇪 Belgium", "BEL"),
+    ("🇧🇩 Bangladesh", "BGD"),
+    ("🇧🇦 Bosnia and Herzegovina", "BIH"),
+    ("🇦🇿 Azerbaijan", "AZE"),
+    ("🇦🇺 Australia", "AUS"),
+    ("🇦🇹 Austria", "AUT"),
+    ("🇦🇷 Argentina", "ARG"),
+    ("🇦🇴 Angola", "AGO"),
+    ("🇦 Netherlands Antilles", "ANT"),
+    ("🇦🇲 Armenia", "ARM"),
+    ("🇦🇱 Albania", "ALB"),
+    ("🇦🇪 United Arab Emirates", "ARE")
+]
+
+def find_mix(code: str):
+    # TODO: Maybe more optimal to construct database at the beginning of the app
+    #       in the same fashion as find_model
+    res = []
+    with open(PATH) as fd:
+        csv = DictReader(fd)
+        for row in csv:
+            res += [float(row[code])]
+    return res