Merge pull request #8 from oyve/dev

Refactor, more functions

Author: oyve

README.md

@@ -1,6 +1,6 @@
 {
   "name": "weather-formulas",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "description": "A collection of atmospheric, meteorological weather calculations",
   "type": "module",
   "main": "dist/cjs/index.cjs",
@@ -17,10 +17,15 @@
       "import": "./dist/esm/formulas/airDensity.js",
       "types": "./dist/types/formulas/airDensity.d.ts"
     },
+    "./altitude": {
+      "require": "./dist/cjs/formulas/altitude.cjs",
+      "import": "./dist/esm/formulas/altitude.js",
+      "types": "./dist/types/formulas/altitude.d.ts"
+    },
     "./diurnalRythm": {
-      "require": "./dist/cjs/formulas/diurnalRythm.cjs",
-      "import": "./dist/esm/formulas/diurnalRythm.js",
-      "types": "./dist/types/formulas/diurnalRythm.d.ts"
+      "require": "./dist/cjs/phenomena/diurnalRythm.cjs",
+      "import": "./dist/esm/phenomena/diurnalRythm.js",
+      "types": "./dist/types/phenomena/diurnalRythm.d.ts"
     },
     "./humidity": {
       "require": "./dist/cjs/formulas/humidity.cjs",
@@ -42,6 +47,21 @@
       "import": "./dist/esm/formulas/wind.js",
       "types": "./dist/types/formulas/wind.d.ts"
     },
+    "./heatIndex": {
+      "require": "./dist/cjs/scales/heatIndex.cjs",
+      "import": "./dist/esm/scales/heatIndex.js",
+      "types": "./dist/types/scales/heatIndex.d.ts"
+    },
+    "./humidex": {
+      "require": "./dist/cjs/indices/humidex.cjs",
+      "import": "./dist/esm/indices/humidex.js",
+      "types": "./dist/types/indices/humidex.d.ts"
+    },
+    "./fog": {
+      "require": "./dist/cjs/phenomena/fog.cjs",
+      "import": "./dist/esm/phenomena/fog.js",
+      "types": "./dist/types/phenomena/fog.d.ts"
+    },
     "./beaufort": {
       "require": "./dist/cjs/scales/beaufort.cjs",
       "import": "./dist/esm/scales/beaufort.js",
@@ -51,6 +71,11 @@
       "require": "./dist/cjs/scales/saffirSimpson.cjs",
       "import": "./dist/esm/scales/saffirSimpson.js",
       "types": "./dist/types/scales/saffirSimpson.d.ts"
+    },
+    "./uvindex": {
+      "require": "./dist/cjs/scales/uvindex.cjs",
+      "import": "./dist/esm/scales/uvindex.js",
+      "types": "./dist/types/scales/uvindex.d.ts"
     }
   },
   "files": [
@@ -104,9 +129,15 @@
   "homepage": "https://github.com/oyve/weather-formulas#readme",
   "devDependencies": {
     "@types/jest": "^29.5.14",
+    "@types/regression": "^2.0.6",
+    "@types/suncalc": "^1.9.2",
     "jest": "^29.7.0",
     "ts-jest": "^29.2.6",
     "ts-node": "^10.9.2",
     "typescript": "^5.8.3"
+  },
+  "dependencies": {
+    "regression": "^2.0.1",
+    "suncalc": "^1.9.0"
   }
-}
+}

package-lock.json

@@ -28,16 +28,31 @@ function generateExports(directory) {
     };
   });
 
-  // Read, update, and write the package.json file
-
   console.log(`Generated exports for directory /${directory}`);
   return exportsField;
 }
 
-let exportFormulas = generateExports('formulas');
-let scalesFormulas = generateExports('scales');
+function getSubdirectories(srcPath) {
+  return fs.readdirSync(srcPath)
+    .filter(name => fs.statSync(path.join(srcPath, name)).isDirectory());
+}
 
-const exportsField = {...exportFormulas, ...scalesFormulas };
+// Dynamically get all subdirectories under src
+const srcDir = path.resolve(__dirname, '../src');
+const subdirs = getSubdirectories(srcDir);
+
+let exportsField = {
+  '.': {
+    require: './dist/cjs/index.cjs',
+    import: './dist/esm/index.js',
+    types: "./dist/types/index.d.ts"
+  },
+};
+
+subdirs.forEach(dir => {
+  const dirExports = generateExports(dir);
+  Object.assign(exportsField, dirExports);
+});
 
 const pkgPath = path.resolve(__dirname, '../package.json');
 const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'));

package.json

@@ -1,5 +1,7 @@
 export interface Reading {
     temperature: number, //kelvin
+    pressure: number, //meter
     altitude: number, //meter
-    datetime: Date
+    relativeHumidity: number, //relative humidity in %
+    timestamp: number
 }

scripts/generate-exports.cjs

@@ -5,7 +5,14 @@ export const STANDARD_MEAN_TEMPERATURE_CELCIUS = 15;
 export const STANDARD_MEAN_TEMPERATURE_KELVIN = 288.15;
 export const STANDARD_LAPSE_RATE = 0.0065;
 
-export const DEW_POINT_VALUATIONS = {
+export interface IValuationSet {
+    a: number, //millibar
+    b: number, //constant
+    c: number, //celcius degrees
+    d: number; //celcius degrees
+}
+
+export const DEW_POINT_VALUATIONS: Record<string, IValuationSet> = {
     ARDENBUCK_DEFAULT: { a: 6.1121, b: 18.678, c: 257.14, d: 234.5 },
     DAVID_BOLTON: { a: 6.112, b: 17.67, c: 234.5, d: 234.5 }, //maximum error of 0.1%, for −30 °C ≤ T ≤ 35°C and 1% < RH < 100%
     SONNTAG1990: { a: 6.112, b: 17.62, c: 243.12, d: 234.5 }, //for −45 °C ≤ T ≤ 60 °C (error ±0.35 °C).
@@ -45,4 +52,18 @@ export const SATURATION_VAPOR_PRESSURE_COEFFICIENTS: SaturationVaporCoefficients
     REFERENCE_PRESSURE: 611.2, // Reference pressure at 0°C in Pascals
     MAGNUS_CONSTANT_B: 17.62, // Empirical constant for water vapor
     MAGNUS_CONSTANT_C: 243.12, // Empirical constant for water vapor in Celsius
-} as const;
+} as const;
+
+export interface THERMODYNAMIC_CONSTANTS {
+    Rd: number; // Gas constant for dry air (J/(kg·K))
+    Cp: number; // Specific heat at constant pressure (J/(kg·K))
+    Lv: number; // Latent heat of vaporization (J/kg)
+    p0: number; // Reference pressure (Pa, 1000 hPa)
+};
+
+export const DEFAULT_THERMODYNAMIC_CONSTANTS: THERMODYNAMIC_CONSTANTS = {
+    Rd: 287,        // Gas constant for dry air (J/(kg·K))
+    Cp: 1004,       // Specific heat at constant pressure (J/(kg·K))
+    Lv: 2.5e6,      // Latent heat of vaporization (J/kg)
+    p0: 100000      // Reference pressure (Pa, 1000 hPa)
+};

src/common.ts

@@ -6,8 +6,6 @@ import * as c from '../constants';
  * Supports both dry air and moist air calculations.
  * @param {number} pressure - Atmospheric pressure in Pascals (Pa).
  * @param {number} temperature - Temperature in Kelvin (K).
- * @param {number} humidity - Relative Humidity in percentage (%).
- * @param {boolean} [isDryAir=false] - Whether to calculate for dry air (ignores humidity).
  * @param {number} [gasConstant=287.05] - Specific gas constant for dry air (J/(kg·K)).
  * @returns {number} - Air density in kilograms per cubic meter (kg/m³).
  */

src/constants.ts

@@ -0,0 +1,18 @@
+/**
+ * Estimate the altitude (in meters) where the temperature drops below freezing (0°C).
+ * Assumes a linear lapse rate (default: 0.0065 K/m).
+ * @param {number} surfaceTemp - Surface temperature in Kelvin.
+ * @param {number} surfaceAltitude - Surface altitude in meters.
+ * @param {number} lapseRate - Lapse rate in Kelvin per meter (default: 0.0065).
+ * @returns {number | null} Altitude in meters where temperature is 273.15 K (0°C), or null if already below freezing.
+ */
+export function freezingLevelAltitude(
+    surfaceTemp: number,
+    surfaceAltitude: number = 0,
+    lapseRate: number = 0.0065
+): number | null {
+    if (surfaceTemp <= 273.15) return null; // Already freezing or below at surface
+    // Calculate altitude difference needed to reach 0°C (273.15 K)
+    const altitudeDiff = (surfaceTemp - 273.15) / lapseRate;
+    return surfaceAltitude + altitudeDiff;
+}

src/formulas/airDensity.ts

@@ -112,4 +112,15 @@ export function specificGasConstantForMoistAir(mixingRatio: number): number {
  */
 export function dewPointDepression(airTemperature: number, dewPointTemperature: number): number {
     return airTemperature - dewPointTemperature;
+}
+
+/**
+ * Calculate the Lifting Condensation Level (LCL) in meters.
+ * If LCL is near the surface, fog is likely.
+ * @param {number} temperature - Air temperature in Kelvin
+ * @param {number} dewPoint - Dew point temperature in Kelvin
+ * @returns {number} LCL in meters
+ */
+export function liftingCondensationLevel(temperature: number, dewPoint: number): number {
+    return 125 * (temperature - dewPoint);
 }