libwx

package module
v1.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 9, 2024 License: MIT Imports: 2 Imported by: 0

README

github.com/cdzombak/libwx

Go Reference

This package primarily provides some weather/atmospheric-related calculations. It also provides types for these calculations to traffic, helping to reduce the chance of mixing up units.

For example, these types prevent accidentally using a Celsius temperature as a Fahrenheit temperature:

Custom types allow your IDE/build to prevent accidental unit confusion.

Documentation: pkg.go.dev/github.com/cdzombak/libwx

Installation

go get github.com/cdzombak/libwx

Usage

Dew point calculation

DewPointF() and DewPointC() calculate the dew point, given a temperature and relative humidity.

Indoor humidity recommendation

IndoorHumidityRecommendationF() and IndoorHumidityRecommendationC() provide a recommended maximum indoor humidity percentage for the given outdoor temperature.

Wind chill calculation

WindChillF() and WindChillC() calculate the wind chill, given the outdoor temperature and wind speed.

The wind chill formula works given temperatures less than 50ºF and wind speeds greater than 3 mph. To calculate wind chill but return an error if the input is outside this range, use WindChillFWithValidation() and WindChillCWithValidation(). These functions return ErrInputRange if the input is out of the formula's input range.

Wet bulb temperature calculation

WetBulbF() and WetBulbC() calculate the wet bulb temperature, given the dry bulb temperature and relative humidity.

This formula is taken from "Wet-Bulb Temperature from Relative Humidity and Air Temperature" (Roland Stull, Journal of Applied Meteorology and Climatology, 2011) and assumes standard sea level pressure.

These functions return ErrInputRange if the input is out of the formula's input range.

Heat index calculation

HeatIndexFWithValidation() and HeatIndexCWithValidation() calculate the heat index, given a temperature and relative humidity.

Heat index warning levels

HeatIndexWarningF() and HeatIndexWarningC() provide a warning level based on the heat index. These warning levels are based on the NOAA's heat index table:

  • HeatIndexWarningNone indicates the heat index does not warrant elevated caution.
  • HeatIndexWarningCaution indicates fatigue is possible with prolonged exposure and activity. Continuing activity could result in heat cramps.
  • HeatIndexWarningExtremeCaution indicates heat cramps and heat exhaustion are possible. Continuing activity could result in heat stroke.
  • HeatIndexWarningDanger indicates heat cramps and heat exhaustion are likely; heat stroke is probable with continued activity.
  • HeatIndexWarningExtremeDanger indicates heat stroke is imminent.
Distance types & conversions

The following distance types are provided:

Each type provides methods to convert to the other types (e.g. NauticalMile.Meters()). An Unwrap() method also exists to get the raw value as a float64.

Humidity type

The RelHumidity type is an integer type representing a relative humidity percentage from 0-100, inclusive. A clamping method and function for this range are provided.

An Unwrap() method also exists to get the raw value as an int; UnwrapFloat64() returns the value as a float64.

Pressure types and conversions

The following pressure types are provided:

Each type provides methods to convert to the other type (e.g. PressureInHg.Mb()). An Unwrap() method also exists to get the raw value as a float64.

Speed types and conversions

The following speed types are provided:

Each type provides methods to convert to the other types (e.g. SpeedKnots.Mph()). An Unwrap() method also exists to get the raw value as a float64.

Temperature types and conversions

The following temperature types are provided:

Each type provides methods to convert to the other type (e.g. TempF.C()). An Unwrap() method also exists to get the raw value as a float64.

Utilities: Comparisons

Finally, libwx provides some utility functions for comparing float64 and int values:

The *Compare(…) functions return:

  • -1 if a < b
  • 0 if a == b
  • 1 if a > b

For float64 comparisons functions that accept a tolerance, convenience tolerance constants are provided:

ToleranceExact = float64(0.0)
Tolerance0     = float64(1.0)
Tolerance1     = float64(0.1)
Tolerance01    = float64(0.01)
Tolerance001   = float64(0.001)
Curried float64 comparisons

When making repeated comparisons with the same tolerance, having to pass the tolerance each time is tedious and increases room for human error. To help with this, curried versions of Float64Compare() and Float64Equal() are provided. These return a comparison function with the specified tolerance baked-in:

For example:

package main

import (
	wx "github.com/cdzombak/libwx"
)

function main() {
	equalityChecker := wx.CurriedFloat64Equal(Tolerance1)

	equalityChecker(1.0, 1.11) // => false
	equalityChecker(1.0, 1.01) // => true
}

License

MIT; see LICENSE in this repo.

Author

Chris Dzombak

Documentation

Index

Constants

View Source 
const (
	ToleranceExact = float64(0.0)
	Tolerance0     = float64(1.0)
	Tolerance1     = float64(0.1)
	Tolerance01    = float64(0.01)
	Tolerance001   = float64(0.001)
	Tolerace1      = Tolerance1 // deprecated; wasa a typo in a previous release
)
View Source 
const (
	// HeatIndexWarningNone indicates the heat index does not warrant elevated caution.
	HeatIndexWarningNone = iota
	// HeatIndexWarningCaution indicates fatigue is possible with prolonged exposure and activity. Continuing activity could result in heat cramps.
	HeatIndexWarningCaution
	// HeatIndexWarningExtremeCaution indicates heat cramps and heat exhaustion are possible. Continuing activity could result in heat stroke.
	HeatIndexWarningExtremeCaution
	// HeatIndexWarningDanger indicates heat cramps and heat exhaustion are likely; heat stroke is probable with continued activity.
	HeatIndexWarningDanger
	// HeatIndexWarningExtremeDanger indicates heat stroke is imminent.
	HeatIndexWarningExtremeDanger
)

Variables

View Source 
var ErrInputRange = errors.New("one or more input values are outside the calculation's supported range")

Functions

func CurriedFloat64Compare added in v1.0.0 

func CurriedFloat64Compare(tolerance float64) func(float64, float64) int

func CurriedFloat64Equal added in v1.0.0 

func CurriedFloat64Equal(tolerance float64) func(float64, float64) bool

func Float64Compare added in v1.0.0 

func Float64Compare(a, b, tolerance float64) int

func Float64Equal added in v1.0.0 

func Float64Equal(a, b, tolerance float64) bool

func IntCompare added in v1.0.0 

func IntCompare(a, b int) int

Types

type HeatIndexWarning added in v1.1.0 

type HeatIndexWarning int

func HeatIndexWarningC added in v1.1.0 

func HeatIndexWarningC(heatIndex TempC) HeatIndexWarning

HeatIndexWarningC returns a heat index warning level for the given heat index temperature (in Celsius) per https://en.wikipedia.org/wiki/Heat_index#Table_of_values captured on 2024-07-17.

func HeatIndexWarningF added in v1.1.0 

func HeatIndexWarningF(heatIndex TempF) HeatIndexWarning

HeatIndexWarningF returns a heat index warning level for the given heat index temperature (in Fahrenheit) per https://en.wikipedia.org/wiki/Heat_index#Table_of_values captured on 2024-07-17.

type Km added in v1.0.0 

type Km float64

Km represents distance in kilometers.

func (Km) Meters added in v1.0.1 

func (km Km) Meters() Meter

Meters returns the distance in meters.

func (Km) Miles added in v1.0.0 

func (km Km) Miles() Mile

Miles returns the distance in miles.

func (Km) NauticalMiles added in v1.0.0 

func (km Km) NauticalMiles() NauticalMile

NauticalMiles returns the distance in nautical miles.

func (Km) Unwrap added in v1.0.0 

func (km Km) Unwrap() float64

type Meter added in v1.0.1 

type Meter float64

Meter represents distance in meters.

func (Meter) Km added in v1.0.1 

func (m Meter) Km() Km

Km returns the distance in kilometers.

func (Meter) Miles added in v1.0.1 

func (m Meter) Miles() Mile

Miles returns the distance in miles.

func (Meter) NauticalMiles added in v1.0.1 

func (m Meter) NauticalMiles() NauticalMile

NauticalMiles returns the distance in nautical miles.

func (Meter) Unwrap added in v1.0.1 

func (m Meter) Unwrap() float64

type Mile added in v1.0.0 

type Mile float64

Mile represents distance in miles.

func (Mile) Km added in v1.0.0 

func (mi Mile) Km() Km

Km returns the distance in kilometers.

func (Mile) Meters added in v1.0.1 

func (mi Mile) Meters() Meter

Meters returns the distance in meters.

func (Mile) NauticalMiles added in v1.0.0 

func (mi Mile) NauticalMiles() NauticalMile

NauticalMiles returns the distance in nautical miles.

func (Mile) Unwrap added in v1.0.0 

func (mi Mile) Unwrap() float64

type NauticalMile added in v1.0.0 

type NauticalMile float64

NauticalMile represents distance in nautical miles.

func (NauticalMile) Km added in v1.0.0 

func (nm NauticalMile) Km() Km

Km returns the distance in kilometers.

func (NauticalMile) Meters added in v1.0.1 

func (nm NauticalMile) Meters() Meter

Meters returns the distance in meters.

func (NauticalMile) Miles added in v1.0.0 

func (nm NauticalMile) Miles() Mile

Miles returns the distance in miles.

func (NauticalMile) Unwrap added in v1.0.0 

func (nm NauticalMile) Unwrap() float64

type PressureInHg 

type PressureInHg float64

PressureInHg represents barometric pressure in inches of mercury.

func (PressureInHg) Mb added in v1.0.0 

func (p PressureInHg) Mb() PressureMb

Mb converts pressure in inches of mercury to millibars.

func (PressureInHg) Unwrap added in v1.0.0 

func (p PressureInHg) Unwrap() float64

type PressureMb 

type PressureMb float64

PressureMb represents barometric pressure in millibars.

func (PressureMb) InHg added in v1.0.0 

func (p PressureMb) InHg() PressureInHg

InHg converts pressure in millibars to inches of mercury.

func (PressureMb) Unwrap added in v1.0.0 

func (p PressureMb) Unwrap() float64

type RelHumidity 

type RelHumidity int

RelHumidity represents a relative humidity percentage (0-100, inclusive).

func ClampedRelHumidity added in v1.0.0 

func ClampedRelHumidity(rh int) RelHumidity

ClampedRelHumidity returns a RelHumidity from the given integer, guaranteed to be within the valid 0-100 (inclusive) range.

func IndoorHumidityRecommendationC 

func IndoorHumidityRecommendationC(outdoorT TempC) RelHumidity

IndoorHumidityRecommendationC returns the maximum recommended indoor relative humidity percentage for the given outdoor temperature (in degrees C).

func IndoorHumidityRecommendationF 

func IndoorHumidityRecommendationF(outdoorT TempF) RelHumidity

IndoorHumidityRecommendationF returns the maximum recommended indoor relative humidity percentage for the given outdoor temperature (in degrees F).

func (RelHumidity) Clamped added in v1.0.0 

func (rh RelHumidity) Clamped() RelHumidity

Clamped returns a relative humidity guaranteed to be within the valid 0-100 (inclusive) range.

func (RelHumidity) Unwrap added in v1.0.0 

func (rh RelHumidity) Unwrap() int

func (RelHumidity) UnwrapFloat64 added in v1.1.0 

func (rh RelHumidity) UnwrapFloat64() float64

type SpeedKmH added in v1.0.0 

type SpeedKmH float64

SpeedKmH represents speed in kilometers per hour.

func (SpeedKmH) Knots added in v1.0.0 

func (s SpeedKmH) Knots() SpeedKnots

Knots returns the speed in knots.

func (SpeedKmH) Mph added in v1.0.0 

func (s SpeedKmH) Mph() SpeedMph

Mph returns the speed in miles per hour.

func (SpeedKmH) Unwrap added in v1.0.0 

func (s SpeedKmH) Unwrap() float64

type SpeedKnots added in v1.0.0 

type SpeedKnots float64

SpeedKnots represents speed in knots.

func (SpeedKnots) KmH added in v1.0.0 

func (s SpeedKnots) KmH() SpeedKmH

KmH returns the speed in kilometers per hour.

func (SpeedKnots) Mph added in v1.0.0 

func (s SpeedKnots) Mph() SpeedMph

Mph returns the speed in miles per hour.

func (SpeedKnots) Unwrap added in v1.0.0 

func (s SpeedKnots) Unwrap() float64

type SpeedMph added in v1.0.0 

type SpeedMph float64

SpeedMph represents speed (e.g. wind speed) in miles per hour.

func (SpeedMph) KmH added in v1.0.0 

func (s SpeedMph) KmH() SpeedKmH

KmH returns the speed in kilometers per hour.

func (SpeedMph) Knots added in v1.0.0 

func (s SpeedMph) Knots() SpeedKnots

Knots returns the speed in knots.

func (SpeedMph) Unwrap added in v1.0.0 

func (s SpeedMph) Unwrap() float64

type TempC 

type TempC float64

TempC represents a temperature in degrees Celsius.

func DewPointC 

func DewPointC(t TempC, rh RelHumidity) TempC

DewPointC calculates the dew point given the current temperature (in Celsius) and relative humidity percentage (an integer 0-100, *not* a float 0.0-1.0).

func HeatIndexC added in v1.1.0 

func HeatIndexC(temp TempC, rh RelHumidity) TempC

HeatIndexC is deprecated; use HeatIndexCWithValidation

func HeatIndexCWithValidation added in v1.2.0 

func HeatIndexCWithValidation(temp TempC, rh RelHumidity) (TempC, error)

HeatIndexCWithValidation calculates the heat index for the given temperature (in Celsius) and relative humidity percentage.

func WetBulbC added in v1.1.0 

func WetBulbC(temp TempC, rh RelHumidity) (TempC, error)

WetBulbC calculates the wet bulb temperature (in Celsius) given a dry bulb temperature (in Celsius) and relative humidity percentage. If the given temperature or relative humidity are outside the supported range, ErrInputRange is returned. See: https://journals.ametsoc.org/view/journals/apme/50/11/jamc-d-11-0143.1.xml

func WindChillC 

func WindChillC(temp TempC, windSpeed SpeedMph) TempC

WindChillC calculates the wind chill for the given temperature (in Celsius) and wind speed (in miles/hour). If wind speed is less than 3 mph, or temperature is over 10 degrees C, the given temperature is returned - the formula works below 10 degrees C and above 3 mph.

func WindChillCWithValidation added in v1.1.0 

func WindChillCWithValidation(temp TempC, windSpeed SpeedMph) (TempC, error)

WindChillCWithValidation calculates the wind chill for the given temperature (in Celsius) and wind speed (in miles/hour). If wind speed or temperature are outside the supported range, ErrInputRange is returned.

func (TempC) F added in v1.0.0 

func (t TempC) F() TempF

F converts Celsius temperature to Fahrenheit.

func (TempC) Unwrap added in v1.0.0 

func (t TempC) Unwrap() float64

type TempF 

type TempF float64

TempF represents a temperature in degrees Fahrenheit.

func DewPointF 

func DewPointF(t TempF, rh RelHumidity) TempF

DewPointF calculates the dew point given the current temperature (in Fahrenheit) and relative humidity percentage (an integer 0-100, *not* a float 0.0-1.0).

func HeatIndexF added in v1.1.0 

func HeatIndexF(temp TempF, rh RelHumidity) TempF

HeatIndexF is deprecated; use HeatIndexFWithValidation

func HeatIndexFWithValidation added in v1.2.0 

func HeatIndexFWithValidation(temp TempF, rh RelHumidity) (TempF, error)

HeatIndexFWithValidation calculates the heat index for the given temperature (in Fahrenheit) and relative humidity percentage.

func WetBulbF added in v1.1.0 

func WetBulbF(temp TempF, rh RelHumidity) (TempF, error)

WetBulbF calculates the wet bulb temperature (in Fahrenheit) given a dry bulb temperature (in Fahrenheit) and relative humidity percentage. If the given temperature or relative humidity are outside the supported range, ErrInputRange is returned. See: https://journals.ametsoc.org/view/journals/apme/50/11/jamc-d-11-0143.1.xml

func WindChillF 

func WindChillF(t TempF, windSpeed SpeedMph) TempF

WindChillF calculates the wind chill for the given temperature (in Fahrenheit) and wind speed (in miles/hour). If wind speed is less than 3 mph, or temperature is over 50 degrees F, the given temperature is returned - the formula works below 50 degrees F and above 3 mph.

func WindChillFWithValidation added in v1.1.0 

func WindChillFWithValidation(t TempF, windSpeed SpeedMph) (TempF, error)

WindChillFWithValidation calculates the wind chill for the given temperature (in Fahrenheit) and wind speed (in miles/hour). If wind speed or temperature are outside the supported range, ErrInputRange is returned.

func (TempF) C added in v1.0.0 

func (t TempF) C() TempC

C converts Fahrenheit temperature to Celsius.

func (TempF) Unwrap added in v1.0.0 

func (t TempF) Unwrap() float64

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.