weather-formulas

A library of atmospheric and weather-related formulas.

import { temperature } from 'weather-formulas';
const dewPoint = temperature.dewPointMagnusFormula(298.15, 60);
console.log(`Dew Point: ${dewPoint} K`);

• Test code for all formulas.
• Supports provided and custom valuation sets, and configurable parameters where applicable.
• Supports both ES Module (ESM) and CommonJS (CJS).

Table of Contents

• Features
  • Air Density
  • Altitude
  • Humidity
  • Pressure
  • Temperature
  • Wind
  • Scales
• Install
• Usage
  • ES Modules (ESM)
  • CommonJS (CJS)
  • TypeScript
  • Advanced Examples
• Testing
• Compatibility
• Contribute
• License
• Support
• Disclaimer

Features

Air Density

Altitude

Humidity

Pressure

Temperature

Wind

Phenomena

Scales

Install

Install the library using npm:

$ npm install weather-formulas

Usage

Note: All temperatures must be provided and are returned in Kelvin (the SI unit for temperature).

ES Modules (ESM)

If your project is configured to use ES Modules (e.g., "type": "module" in package.json), you can use the import syntax to load the package:

import { temperature, humidity, pressure, wind, airDensity } from 'weather-formulas';

// Example usage
const RH = humidity.relativeHumidity(298.15, 293.15); // 25°C and 20°C in Kelvin
console.log(`Relative Humidity: ${RH}%`);

CommonJS (CJS)

If your project uses CommonJS (e.g., no "type": "module" in package.json), you can use the require syntax to load the package:

const { temperature, humidity, pressure, wind, airDensity } = require('weather-formulas');

// Example usage
const RH = humidity.relativeHumidity(298.15, 293.15); // 25°C and 20°C in Kelvin
console.log(`Relative Humidity: ${RH}%`);

TypeScript

import { temperature } from 'weather-formulas';

const dewPoint: number = temperature.dewPointMagnusFormula(298.15, 60); // 25°C and 60% humidity
console.log(`Dew Point: ${dewPoint} K`);

Advanced Examples

Use a provided valuation set:

const valuationSet = temperature.DEW_POINT_VALUATIONS.DAVID_BOLTON;
const actual = temperature.dewPointMagnusFormula(298.15, 60, valuationSet); // 25°C and 60% humidity
console.log(`Dew Point: ${actual} K`);

Use a custom valuation set:

const valuationSet = { a: 6, b: 17, c: 250, d: 234.5 };
const actual = temperature.dewPointArdenBuckEquation(298.15, 60, valuationSet); // 25°C and 60% humidity
console.log(`Dew Point: ${actual} K`);

Inspect code/tests for all possibilities.

Testing

All formulas are covered by automated tests.
Run tests with:

npm run test

Compatibility

• Requires Node.js 18+.
• Fully typed with TypeScript (v5+).
• Supports both ES Modules (ESM) and CommonJS (CJS).

Contribute

Please feel free to contribute by creating a Pull Request including test code, or by suggesting other formulas.

License

This project is licensed under the GPL v3 License.

Support

For support, please open an issue in the GitHub repository.

Disclaimer

While the formulas are implemented with care, results may vary due to floating point errors, edge cases, or incorrect usage. Please verify results and report any issues or inaccuracies.