@hestia-earth/engine-models 0.81.2 → 0.81.5

package/src/models.ts

@@ -1,49 +0,0 @@
-import { EmissionMethodTier } from '@hestia-earth/schema';
-import * as data from '../model-links.json';
-
-export interface IModel {
-  /**
-   * Path to the implementation (code) of the model.
-   */
-  path: string;
-  /**
-   * Path to the documentation of the model.
-   */
-  docPath: string;
-  /**
-   * Path to the documentation of the model on the guide.
-   */
-  guidePath: string;
-  /**
-   * The name of the model used as `methodModel`.
-   */
-  model: string;
-  /**
-   * The term the model is associated with.
-   */
-  term?: string;
-  /**
-   * The methodTier of the Emission (if applicable).
-   */
-  methodTier?: EmissionMethodTier;
-  /**
-   * A key in the model if term does not exist.
-   */
-  modelKey?: string;
-  /**
-   * List of other models this model needs to run.
-   */
-  dependencies?: string[];
-}
-
-export type modelLookup = Record<
-  string,
-  Pick<IModel, 'model' | 'term' | 'modelKey'>[]
->;
-
-export interface IModelLinks {
-  links: IModel[];
-  lookups: Record<string, modelLookup>;
-}
-
-export const models = data as IModelLinks;

package/src/utils.spec.ts

@@ -1,118 +0,0 @@
-import { describe, expect, test } from '@jest/globals';
-
-import { IModel } from './models';
-import { findMatchingModel, findMatchingModelFromConfig } from './utils';
-
-describe('models', () => {
-  describe('findMatchingModel', () => {
-    const model = 'stehfestBouwman2006';
-    const term = 'noxToAirInorganicFertiliser';
-    const path =
-      'hestia_earth/models/stehfestBouwman2006/noxToAirInorganicFertiliser.py';
-
-    test('should find by model', () => {
-      const params = { model, term } as Partial<IModel>;
-
-      expect(findMatchingModel(params)).toEqual(
-        expect.objectContaining({ model, term, path })
-      );
-    });
-
-    test('should handle values with dot', () => {
-      expect(
-        findMatchingModel(
-          {
-            model: 'ipcc2019',
-            term: 'animal.pregnancyRateTotal'
-          },
-          { useDotValues: true }
-        )
-      ).toEqual(
-        expect.objectContaining({
-          model: 'ipcc2019',
-          term: 'pregnancyRateTotal'
-        })
-      );
-    });
-  });
-
-  describe('findMatchingModelFromConfig', () => {
-    test('should handle completeness', () => {
-      const model = 'cycle';
-
-      expect(
-        findMatchingModelFromConfig({
-          model,
-          value: 'completeness'
-        })
-      ).toEqual(
-        expect.objectContaining({
-          model: 'cycle',
-          modelKey: 'completeness.animalFeed'
-        })
-      );
-    });
-
-    test('should handle feedConversionRatio', () => {
-      const model = 'hestia';
-
-      expect(
-        findMatchingModelFromConfig({
-          model,
-          value: 'feedConversionRatio'
-        })
-      ).toEqual(
-        expect.objectContaining({
-          model: 'hestia',
-          term: 'feedConversionRatioCarbon'
-        })
-      );
-    });
-
-    test('should handle ecoinventV3AndEmberClimate', () => {
-      const model = 'ecoinventV3AndEmberClimate';
-
-      expect(
-        findMatchingModelFromConfig({
-          model,
-          value: 'all'
-        })
-      ).toEqual(
-        expect.objectContaining({
-          model
-        })
-      );
-    });
-
-    test('should handle ecoinventV3AndEmberClimate', () => {
-      const model = 'ecoinventV3AndEmberClimate';
-
-      expect(
-        findMatchingModelFromConfig({
-          model,
-          value: 'all'
-        })
-      ).toEqual(
-        expect.objectContaining({
-          model
-        })
-      );
-    });
-
-    test('should handle seed_emissions', () => {
-      const model = 'hestia';
-
-      expect(
-        findMatchingModelFromConfig({
-          model,
-          value: 'seed_emissions'
-        })
-      ).toEqual(
-        expect.objectContaining({
-          model,
-          modelKey: 'seed_emissions'
-        })
-      );
-    });
-  });
-});

package/src/utils.ts

@@ -1,67 +0,0 @@
-import { IOrchestratorModelConfig } from './config';
-import { IModel, models } from './models';
-
-type findMatchFunc = (
-  model: IModel,
-  key: string,
-  value: string | string[]
-) => boolean;
-
-const matchWithDot: findMatchFunc = (model, key, value) =>
-  typeof value === 'string' && value.split('.').pop() === model[key];
-
-const matchPath: findMatchFunc = (model, key, value) =>
-  key === 'path' && typeof value === 'string' && model[key].startsWith(value);
-
-export const findMatchingModel = (
-  model: Partial<IModel>,
-  config: {
-    useDotValues?: boolean;
-  } = {
-    useDotValues: false
-  }
-): IModel =>
-  Object.keys(model).length > 0
-    ? models.links.find((m) =>
-        Object.entries(model).every(
-          ([key, value]) =>
-            value === m[key] ||
-            (config.useDotValues && matchWithDot(m, key, value)) ||
-            matchPath(m, key, value)
-        )
-      )
-    : null;
-
-const modelMatchOrder = ({
-  model,
-  value
-}: Pick<IOrchestratorModelConfig, 'model' | 'value'>) =>
-  [
-    { model, term: value },
-    { model, modelKey: value },
-    {
-      model,
-      modelKey: value.split('.').pop()
-    },
-    {
-      model,
-      term: value.split('.').pop()
-    },
-    {
-      model,
-      path: ['hestia_earth', 'models', model, value].join('/')
-    },
-    !value || value === 'all' ? { model } : null
-  ].filter(Boolean) as Partial<IModel>[];
-
-export const findMatchingModelFromConfig = (
-  model: Pick<IOrchestratorModelConfig, 'model' | 'value'>
-) =>
-  modelMatchOrder(model)
-    .map(
-      (params) =>
-        findMatchingModel(params) ||
-        findMatchingModel(params, { useDotValues: true })
-    )
-    ?.filter(Boolean)
-    ?.shift();

package/src/validate-config.spec.ts

@@ -1,31 +0,0 @@
-import { describe, expect, test } from '@jest/globals';
-
-import {
-  validateConfigOrder,
-  validateConfigDuplicates
-} from './validate-config';
-import { allowedTypes } from './config';
-
-describe('validate-config', () => {
-  describe('validateConfigOrder', () => {
-    for (const nodeType of allowedTypes) {
-      describe(nodeType, () => {
-        test('should not have broken dependencies', () => {
-          const results = validateConfigOrder(nodeType);
-          expect(results).toEqual([]);
-        });
-      });
-    }
-  });
-
-  describe('validateConfigDuplicates', () => {
-    for (const nodeType of allowedTypes) {
-      describe(nodeType, () => {
-        test('should not have duplicates', () => {
-          const results = validateConfigDuplicates(nodeType);
-          expect(results).toEqual([]);
-        });
-      });
-    }
-  });
-});

package/src/validate-config.ts

@@ -1,103 +0,0 @@
-import { allowedType, IOrchestratorModelConfig, loadConfig } from './config';
-import { findMatchingModelFromConfig } from './utils';
-
-// models not included in the links
-const skipModels = ['emissions.deleted', 'transformations'];
-
-const isHestiaResidueCyclicModel = ({
-  model,
-  value
-}: IOrchestratorModelConfig) =>
-  model === 'hestia' && value?.startsWith('residue');
-
-const isOrganicCarbonCyclicModel = ({
-  model,
-  value
-}: IOrchestratorModelConfig) =>
-  model === 'hestia' && value?.startsWith('organicCarbonPer');
-
-const includeModel = (model: IOrchestratorModelConfig) =>
-  [
-    !skipModels.includes(model.model),
-    // cyclic dependencies
-    !isHestiaResidueCyclicModel(model),
-    !isOrganicCarbonCyclicModel(model),
-    !model.key.startsWith('cache')
-  ].every(Boolean);
-
-// dependencies that cannot be validated
-const skipDependencies = [
-  // completeness gap-fills after other models run
-  'completeness'
-];
-
-const matchDependencies =
-  (models: IOrchestratorModelConfig[]) => (model: IOrchestratorModelConfig) => {
-    const { dependencies } = findMatchingModelFromConfig(model);
-    const previousModels = models.slice(0, models.indexOf(model));
-    const existing =
-      dependencies?.filter((value) =>
-        previousModels.some(
-          (config) => config.value?.split('.').pop() === value
-        )
-      ) ?? [];
-    return {
-      model,
-      existing,
-      missing:
-        dependencies
-          // skip dependencies that dont exist at all
-          ?.filter((value) => models.some((config) => config.value === value))
-          ?.filter(
-            (v) =>
-              !existing.includes(v) &&
-              !skipDependencies.includes(v) &&
-              v !== model.value
-          ) ?? []
-    };
-  };
-
-/**
- * Use inter-dependencies to detect models that are in the wrong order.
- *
- * @param nodeType Cycle, Site, or ImpactAssessment
- * @returns List of models that have dependencies that could not be found prior to running.
- */
-export const validateConfigOrder = (nodeType: allowedType) => {
-  const config = loadConfig(nodeType);
-  // flatten all models to process one by one, starting with the last one
-  const models = config.models.flat();
-
-  const results = models.filter(includeModel).map(matchDependencies(models));
-
-  return results.filter((r) => r.missing.length > 0);
-};
-
-const findDuplicatedConfigs = (models: IOrchestratorModelConfig[]) => {
-  const modelsByValue = models.reduce(
-    (prev, curr) => ({
-      ...prev,
-      [curr.value]: [...(prev[curr.value] || []), curr]
-    }),
-    {} as Record<string, IOrchestratorModelConfig[]>
-  );
-  return Object.values(modelsByValue)
-    .map((values) => values.filter((v) => !v.mergeArgs?.sameMethodModel))
-    .filter((values) => values.length > 1);
-};
-
-/**
- * Detect multiple models running in parallel when they should not.
- * Note: we use the `mergeArgs` to handle special cases when multiple identical models CAN run in parallel
- *
- * @param nodeType Cycle, Site, or ImpactAssessment
- */
-export const validateConfigDuplicates = (nodeType: allowedType) => {
-  const config = loadConfig(nodeType);
-
-  const duplicates = config.models
-    .map((value) => (Array.isArray(value) ? findDuplicatedConfigs(value) : []))
-    .flat(2);
-
-  return duplicates;
-};

package/src/version.ts

@@ -1 +0,0 @@
-export const ENGINE_VERSION = '0.81.2';