@tgwf/co2 0.10.3 → 0.10.5

package/data/fixtures/url2green.test.json

@@ -0,0 +1 @@
+["google.com","maxcdn.bootstrapcdn.com","thegreenwebfoundation.org","www.thegreenwebfoundation.org","fonts.googleapis.com","ajax.googleapis.com","assets.digitalclimatestrike.net","cdnjs.cloudflare.com","graphite.thegreenwebfoundation.org","analytics.thegreenwebfoundation.org","fonts.gstatic.com","api.thegreenwebfoundation.org"]

package/data/functions/generate_average_co2.js

@@ -0,0 +1,74 @@
+const fs = require("fs");
+const csv = fs.readFileSync("data/co2-intensities-ember-2021.csv");
+const parseCSVRow = require("../utils/parseCSVRow");
+const getCountryCodes = require("../utils/getCountryCodes");
+const type = "average";
+const source = "Ember";
+const year = "2021";
+
+const array = csv.toString().split("\n");
+
+/* Store the converted result into an array */
+const csvToJsonResult = {};
+const gridIntensityResults = {};
+
+/* Store the CSV column headers into separate variable */
+const headers = parseCSVRow(array[0]);
+
+/* Iterate over the remaining data rows */
+for (let currentArrayString of array) {
+	// If there's an empty line, keep calm and carry on.
+	// Also, skip the first row since those are the headers.
+	if (currentArrayString.length === 0 || currentArrayString === array[0]) continue;
+
+	/* Empty object to store result in key value pair */
+	const jsonObject = {}
+
+	// Split the string by the pipe character
+	let jsonProperties = parseCSVRow(currentArrayString);
+
+	// Ember sets the country value (3-digit country code) in the first column. If data is for a region instead, it will be in the second column.
+	// We can assign the current country (or region) by using these fields.
+	let country = jsonProperties[0] || jsonProperties[1];
+
+	// Loop through the headers and assign the values to the JSON object
+	for (let column in headers) {
+		// First check if the current property is an array string. If so, then we'll split it and map the results to an array.
+		// We trim the values to remove any whitespace.
+		if (jsonProperties[column].includes(",")) {
+			jsonObject[headers[column]] = jsonProperties[column]
+				.split(",").map(item => item.trim());
+		} else {
+			// Otherwise, just assign the value to the JSON object.
+			// We replace \r with an empty string to remove any carriage returns.
+			jsonObject[headers[column].replace("\r", "")] = jsonProperties[column].replace("\r", "")
+		}
+
+		// This extracts only the emissions intensity data from the CSV.
+		// We use this to generate a smaller data file which can be later imported into CO2.js
+		if (headers[column].startsWith('emissions_intensity_gco2_per_kwh')) {
+			gridIntensityResults[country.toUpperCase()] = jsonProperties[column].replace("\r", "")
+		}
+	}
+
+	// Ember keeps the country name in the 2nd column, so we'll use that to map the ISO country codes
+	const countryCodes = getCountryCodes('ember_country_name', jsonProperties[1].toLowerCase());
+
+	/* Push the genearted JSON object to resultant array */	
+	csvToJsonResult[country] = {...jsonObject, ...countryCodes};
+}
+/* Convert the final array to JSON */
+const json = JSON.stringify(csvToJsonResult);
+const gridIntensityJson = JSON.stringify(gridIntensityResults);
+
+// This saves the country code and emissions data only, for use in the CO2.js library
+fs.writeFileSync("data/output/average-intensities-2021.js", `const data = ${gridIntensityJson}; 
+const type = "${type}";
+const year = "${year}";
+export { data, type, year }; 
+export default { data, type, year };`);
+// Save a minified version to the src folder so that it can be easily imported into the library
+fs.writeFileSync("src/data/average-intensities-2021.min.js", `const data = ${gridIntensityJson}; const type = "${type}"; const year = "${year}"; export { data, type, year }; export default { data, type, year };`);
+
+// This saves the full data set as a JSON file for reference.
+fs.writeFileSync("data/output/average-intensities-2021.json", json);

package/data/functions/generate_marginal_co2.js

@@ -0,0 +1,93 @@
+const fs = require("fs");
+const csv = fs.readFileSync("data/IFI_Default_Grid_Factors_2021_v3.1_unfccc.csv");
+const parseCSVRow = require("../utils/parseCSVRow");
+const getCountryCodes = require("../utils/getCountryCodes");
+const type = "marginal";
+const source = "UNFCCC";
+const year = "2021";
+
+const array = csv.toString().split("\n");
+
+/* Store the converted result into an array */
+const csvToJsonResult = {};
+const gridIntensityResults = {};
+
+/* Store the CSV column headers into seprate variable */
+const rowHeaders = parseCSVRow(array[4]);
+rowHeaders.push(...parseCSVRow(array[3]));
+rowHeaders.push("Operating Margin Grid Emission");
+
+const headers = rowHeaders.filter((header) => header !== "");
+
+/* Iterate over the remaining data rows */
+// Here we remove the first 5 items in the array, since these are the headings which we have already accounted for
+for (let currentArrayString of array.slice(5)) {
+
+  // If there's an empty line, keep calm and carry on.
+  if (currentArrayString.length === 0) continue;
+
+  /* Empty object to store result in key value pair */
+  const jsonObject = {};
+
+	// Split the string by the pipe character
+  let jsonProperties = parseCSVRow(currentArrayString);
+
+  if (jsonProperties.length < 2) continue;
+
+  // The UNFCCC data sets the country value (full country name as string) in the first column, so we can extract that.
+  let country = jsonProperties[0];
+
+  // If there's no value for the country, then we can skip this row.
+  if (!country || country === "") continue;
+
+  // UNFCCC keeps the country name in the 1st column, so we'll use that to map the ISO country codes
+  const countryCodes = getCountryCodes('unfccc_country_name', country.toLowerCase());
+
+  // Loop through the headers and assign the values to the JSON object
+  for (let column in headers) {
+    if (!column || column === "") continue;
+
+    // First check if the current property is an array string. If so, then we'll split it and map the results to an array.
+		// We trim the values to remove any whitespace.
+    if (jsonProperties[column].includes(",")) {
+      jsonObject[headers[column]] = jsonProperties[column]
+        .split(",")
+        .map((item) => item.trim());
+    } else {
+      // Otherwise, just assign the value to the JSON object.
+			// We replace \r with an empty string to remove any carriage returns.
+      // We also remove any quotations in the strings.
+      jsonObject[headers[column].replace("\r", "").replaceAll('\"', "")] =
+        jsonProperties[column].replace("\r", "").replace('\"', "");
+    }
+
+    if (headers[column].startsWith("Operating Margin Grid Emission")) {
+      gridIntensityResults[countryCodes.country_code_iso_3.toUpperCase() || country.toUpperCase()] = jsonProperties[column]
+        .replace("\r", "")
+        .replace('\"', "");
+      }
+    }
+
+
+  /* Push the genearted JSON object to resultant array */
+  csvToJsonResult[country] = {...jsonObject, ...countryCodes};;
+}
+/* Convert the final array to JSON */
+const json = JSON.stringify(csvToJsonResult);
+const gridIntensityJson = JSON.stringify(gridIntensityResults);
+
+// This saves the country code and emissions data only, for use in the CO2.js library
+fs.writeFileSync(
+  "data/output/marginal-intensities-2021.js",
+  `const data = ${gridIntensityJson}; 
+  const type = "${type}";
+const year = "${year}";
+export { data, type, year }; 
+export default { data, type, year };`);
+// Save a minified version to the src folder so that it can be easily imported into the library
+fs.writeFileSync(
+  "src/data/marginal-intensities-2021.min.js",
+  `const data = ${gridIntensityJson}; const type = "${type}"; const year = "${year}"; export { data, type, year }; export default { data, type, year };` );
+
+// This saves the full data set as a JSON file for reference.
+fs.writeFileSync("data/output/marginal-intensities-2021.json", json);

package/data/generate_co2_constants.py

@@ -0,0 +1,28 @@
+import csv
+import json
+
+intensity_by_country = {}
+rows_2020 = None
+rows_2021 = None
+
+# build our first data structure
+with open("data/co2-intensities-ember-2020.csv") as ember2020:
+
+    rows_2020 = csv.DictReader(ember2020)
+    for row in rows_2020:
+        if row["country_code"]:
+            intensity_by_country[row["country_code"]] = row
+
+
+# now add the latest year
+with open("data/co2-intensities-ember-2021.csv") as ember2021:
+    rows_2021 = csv.DictReader(ember2021)
+    for row in rows_2021:
+        if row["country_code"]:
+            intensity_by_country[row["country_code"]] = row
+
+# TODO add the figure for world, and the EU, africa and other groupings
+
+with open("data/intensity-by-country.json", "w+") as outfile:
+    outfile.write(json.dumps(intensity_by_country))
+

package/data/output/average-intensities-2021.js

@@ -0,0 +1,92 @@
+const data = {
+  AFRICA: "489.26",
+  ARG: "365.292",
+  ARM: "206.522",
+  ASIA: "543.57",
+  AUS: "526.876",
+  AUT: "145.083",
+  AZE: "536.585",
+  BGD: "559.606",
+  BLR: "472.727",
+  BEL: "156.063",
+  BOL: "311.475",
+  BIH: "470.982",
+  BRA: "144.677",
+  BGR: "364.136",
+  BDI: "275.862",
+  CAN: "123.859",
+  CHL: "395.565",
+  CHN: "549.288",
+  CRI: "30.903",
+  HRV: "212.161",
+  CYP: "601.19",
+  CZE: "401.272",
+  DNK: "240.419",
+  ECU: "132.964",
+  EGY: "470.879",
+  SLV: "180.87",
+  EST: "488.529",
+  EU: "261.43",
+  EUROPE: "277.64",
+  FIN: "152.651",
+  FRA: "67.781",
+  G20: "445.9",
+  G7: "338.04",
+  GEO: "105.685",
+  DEU: "363.982",
+  GRC: "363.388",
+  HUN: "236.271",
+  IND: "632.656",
+  IRL: "361.274",
+  ITA: "340.937",
+  JPN: "460.647",
+  KAZ: "656.097",
+  KEN: "104.0",
+  "LATIN AMERICA AND CARIBBEAN": "261.51",
+  LVA: "226.351",
+  LTU: "247.475",
+  LUX: "183.824",
+  MLT: "452.055",
+  MEX: "391.582",
+  MDA: "642.512",
+  MNG: "725.26",
+  MNE: "335.958",
+  NLD: "386.189",
+  "NORTH AMERICA": "345.38",
+  MKD: "444.191",
+  NOR: "26.131",
+  OCEANIA: "479.98",
+  OECD: "338.24",
+  PAK: "363.065",
+  PER: "241.492",
+  PHL: "579.689",
+  POL: "657.138",
+  PRT: "222.632",
+  ROU: "255.718",
+  RUS: "355.431",
+  SAU: "568.967",
+  SEN: "540.098",
+  SRB: "549.083",
+  SGP: "488.21",
+  SVK: "173.854",
+  SVN: "241.956",
+  ZAF: "706.991",
+  KOR: "442.389",
+  ESP: "193.737",
+  SWE: "43.9",
+  CHE: "58.952",
+  TWN: "565.629",
+  TJK: "72.823",
+  THA: "503.034",
+  TUN: "470.848",
+  TUR: "432.293",
+  UKR: "240.28",
+  GBR: "268.255",
+  USA: "378.625",
+  VNM: "491.192",
+  WORLD: "442.37",
+};
+const type = "average";
+const year = "2021";
+export { data, type, year };
+export default { data, type, year };