@grnsft/if 0.0.2

package/examples/ompls/sci-o.yml

@@ -0,0 +1,29 @@
+name: sci-o-demo
+description: null
+tags: null
+initialize:
+  models:
+    - name: sci-e
+      kind: builtin
+    - name: sci-o
+      kind: builtin
+graph:
+  children:
+    child:
+      pipeline:
+        - sci-e
+        - sci-o
+      config:
+        sci-e: null
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          energy-cpu: 0.001
+          grid-carbon-intensity: 800
+      outputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          energy-cpu: 0.001
+          grid-carbon-intensity: 800
+          energy: 0.001
+          operational-carbon: 0.8

package/examples/ompls/sci.yml

@@ -0,0 +1,36 @@
+name: sci-demo
+description: example invoking sci model
+tags: null
+initialize:
+  models:
+    - name: sci
+      kind: builtin
+      path: ''
+graph:
+  children:
+    child:
+      pipeline:
+        - sci
+      config:
+        sci:
+          functional-unit-duration: 1
+          functional-unit-time: minutes
+          functional-unit: requests
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 3600
+          energy: 5
+          operational-carbon: 5
+          embodied-carbon: 0.02
+          requests: 100
+      outputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 3600
+          energy: 5
+          operational-carbon: 5
+          embodied-carbon: 0.02
+          requests: 100
+          functional-unit-duration: 1
+          functional-unit-time: minutes
+          functional-unit: requests
+          sci: 0.0008366666666666665

package/examples/ompls/shell.yml

@@ -0,0 +1,23 @@
+name: ccf-demo
+description: example impl invoking CCF model
+tags: null
+initialize:
+  models:
+    - name: sampler
+      kind: shell
+graph:
+  children:
+    child:
+      pipeline:
+        - sampler
+      config:
+        sampler:
+          executable: python3 /usr/local/bin/sampler
+      inputs:
+        - timestamp: '2023-11-02T10:35:31.820Z'
+          duration: 3600
+      outputs:
+        - duration: 3600
+          energy: 1
+          executable: python3 /usr/local/bin/sampler
+          timestamp: '2023-11-02T10:35:31.820Z'

package/jest.config.js

@@ -0,0 +1,14 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.ts?$': [
+      'ts-jest',
+      {
+        tsconfig: 'tsconfig.test.json',
+      },
+    ],
+  },
+  modulePathIgnorePatterns: ['./build'],
+};

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@grnsft/if",
+  "description": "Impact Framework",
+  "version": "v0.0.2",
+  "publishConfig": {
+    "access": "public"
+  },
+  "bin": {
+    "impact-engine": "./build/index.js"
+  },
+  "author": {
+    "name": "Green Software Foundation",
+    "email": "info@gsf.com"
+  },
+  "bugs": {
+    "url": "https://github.com/Green-Software-Foundation/if/issues/new?assignees=&labels=feedback&projects=&template=feedback.md&title=Feedback+-+"
+  },
+  "dependencies": {
+    "@azure/arm-compute": "^21.2.0",
+    "@azure/arm-monitor": "^7.0.0",
+    "@azure/identity": "^4.0.0",
+    "@cloud-carbon-footprint/aws": "^0.15.0",
+    "@cloud-carbon-footprint/core": "^0.17.3",
+    "axios": "^1.4.0",
+    "dayjs": "^1.11.9",
+    "dotenv": "^16.3.1",
+    "js-yaml": "^4.1.0",
+    "node-fetch": "^3.3.1",
+    "ts-sync-request": "^1.4.1",
+    "typescript": "^5.1.6",
+    "typescript-cubic-spline": "^1.0.1",
+    "zod": "^3.22.4"
+  },
+  "devDependencies": {
+    "@babel/core": "7.22.10",
+    "@babel/preset-typescript": "^7.22.5",
+    "@jest/globals": "^29.6.1",
+    "@types/jest": "^29.5.7",
+    "@types/js-yaml": "^4.0.5",
+    "@types/node": "^20.8.9",
+    "fixpack": "^4.0.0",
+    "gts": "^5.0.0",
+    "jest": "^29.6.1",
+    "jest-mock-axios": "^4.7.2",
+    "ts-command-line-args": "^2.5.1",
+    "ts-jest": "^29.1.1"
+  },
+  "engines": {
+    "node": "18",
+    "yarn": "1.22.19"
+  },
+  "homepage": "https://greensoftware.foundation",
+  "keywords": [],
+  "license": "MIT",
+  "main": "build/index.js",
+  "repository": {
+    "url": "https://github.com/Green-Software-Foundation/if"
+  },
+  "scripts": {
+    "build": "tsc",
+    "coverage": "jest --verbose --coverage",
+    "fix": "gts fix",
+    "fix:package": "fixpack",
+    "impact-engine": "npx ts-node impact-engine.ts",
+    "lint": "gts lint",
+    "prepare": "yarn build",
+    "test": "jest --verbose"
+  },
+  "stability": "stable",
+  "types": "src/index.d.ts"
+}

package/scripts/impact-test.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+echo "Starting impact tests"
+prefix="examples/impls/test/";
+for file in examples/impls/test/*;
+do
+echo ""
+echo executing $file, outfile is ${file#"$prefix"}
+echo ""
+npx ts-node impact-engine.ts --impl $file --ompl examples/ompls/${file#"$prefix"}
+done
+exit 0

package/src/__mocks__/boavizta/countries.json

@@ -0,0 +1,138 @@
+{
+  "0-Global": "WOR",
+  "1-Europe": "EEE",
+  "Albania": "ALB",
+  "Algeria": "DZA",
+  "Angola": "AGO",
+  "Argentina": "ARG",
+  "Armenia": "ARM",
+  "Australia": "AUS",
+  "Austria": "AUT",
+  "Azerbaijan": "AZE",
+  "Bahrain": "BHR",
+  "Bangladesh": "BGD",
+  "Belarus": "BLR",
+  "Belgium": "BEL",
+  "Benin": "BEN",
+  "Bolivia": "BOL",
+  "Bosnia and Herzegovina": "BIH",
+  "Botswana": "BWA",
+  "Brazil": "BRA",
+  "Brunei": "BRN",
+  "Bulgaria": "BGR",
+  "Cambodia": "KHM",
+  "Cameroon": "CMR",
+  "Canada": "CAN",
+  "Chile": "CHL",
+  "China": "CHN",
+  "Colombia": "COL",
+  "Congo": "COG",
+  "Costa Rica": "CRI",
+  "Croatia": "HRV",
+  "Cuba": "CUB",
+  "Cyprus": "CYP",
+  "Czech Republic": "CZE",
+  "Denmark": "DNK",
+  "Dominican Republic": "DOM",
+  "DR Congo": "COD",
+  "Ecuador": "ECU",
+  "Egypt": "EGY",
+  "El Salvador": "SLV",
+  "Eritrea": "ERI",
+  "Estonia": "EST",
+  "Ethiopia": "ETH",
+  "Finland": "FIN",
+  "France": "FRA",
+  "Gabon": "GAB",
+  "Georgia": "GEO",
+  "Germany": "DEU",
+  "Ghana": "GHA",
+  "Greece": "GRC",
+  "Guatemala": "GTM",
+  "Haiti": "HTI",
+  "Honduras": "HND",
+  "Hungary": "HUN",
+  "Iceland": "ISL",
+  "India": "IND",
+  "Indonesia": "IDN",
+  "Iran": "IRN",
+  "Iraq": "IRQ",
+  "Ireland": "IRL",
+  "Israel": "ISR",
+  "Italy": "ITA",
+  "Ivory Coast": "CIV",
+  "Jamaica": "JAM",
+  "Japan": "JPN",
+  "Jordan": "JOR",
+  "Kazakhstan": "KAZ",
+  "Kenya": "KEN",
+  "Kuwait": "KWT",
+  "Kyrgyzstan": "KGZ",
+  "Latvia": "LVA",
+  "Lebanon": "LBN",
+  "Libyan Arab Jamahiriya": "LBY",
+  "Lithuania": "LTU",
+  "Luxembourg": "LUX",
+  "Malaysia": "MYS",
+  "Malta": "MLT",
+  "Mexico": "MEX",
+  "Moldova": "MDA",
+  "Mongolia": "MNG",
+  "Morocco": "MAR",
+  "Mozambique": "MOZ",
+  "Myanmar": "MMR",
+  "Namibia": "NAM",
+  "Nepal": "NPL",
+  "Netherlands": "NLD",
+  "New Zealand": "NZL",
+  "Nicaragua": "NIC",
+  "Nigeria": "NGA",
+  "North Korea": "PRK",
+  "North Macedonia": "MKD",
+  "Norway": "NOR",
+  "Oman": "OMN",
+  "Pakistan": "PAK",
+  "Panama": "PAN",
+  "Paraguay": "PRY",
+  "Peru": "PER",
+  "Philippines": "PHL",
+  "Poland": "POL",
+  "Portugal": "PRT",
+  "Qatar": "QAT",
+  "Romania": "ROU",
+  "Russian Federation": "RUS",
+  "Saudi Arabia": "SAU",
+  "Senegal": "SEN",
+  "Serbia": "SCG",
+  "Singapore": "SGP",
+  "Slovakia": "SVK",
+  "Slovenia": "SVN",
+  "South Africa": "ZAF",
+  "South Korea": "KOR",
+  "Spain": "ESP",
+  "Sri Lanka": "LKA",
+  "Sudan": "SDN",
+  "Sweden": "SWE",
+  "Switzerland": "CHE",
+  "Syrian Arab Republic": "SYR",
+  "Taiwan": "TWN",
+  "Tajikistan": "TJK",
+  "Tanzania": "TZA",
+  "Thailand": "THA",
+  "Togo": "TGO",
+  "Trinidad and Tobago": "TTO",
+  "Tunisia": "TUN",
+  "Turkey": "TUR",
+  "Turkmenistan": "TKM",
+  "Ukraine": "UKR",
+  "United Arab Emirates": "ARE",
+  "United Kingdom": "GBR",
+  "United States of America": "USA",
+  "Uruguay": "URY",
+  "Uzbekistan": "UZB",
+  "Venezuela": "VEN",
+  "Vietnam": "VNM",
+  "Yemen": "YEM",
+  "Zambia": "ZMB",
+  "Zimbabwe": "ZWE"
+}