Units#

class polars_extensions.units.UnitExtensionNamespace(expr: Expr)[source]#

Bases: object

A Polars expression namespace for unit conversions.

Methods

`bytes_to_bits`()	Convert bytes to bits.
`bytes_to_gigabytes`()	Convert bytes to gigabytes.
`bytes_to_kilobytes`()	Convert bytes to kilobytes.
`bytes_to_megabytes`()	Convert bytes to megabytes.
`bytes_to_terabytes`()	Convert bytes to terabytes.
`calories_to_joules`()	Convert calories to joules.
`celsius_to_fahrenheit`()	Convert Celsius to Fahrenheit.
`celsius_to_kelvin`()	Convert Celsius to Kelvin.
`centimeters_to_inches`()	Convert centimeters to inches.
`days_to_weeks`()	Convert days to weeks.
`days_to_years`()	Convert days to years (approx, 365 days).
`fahrenheit_to_celsius`()	Convert Fahrenheit to Celsius.
`gallons_to_liters`()	Convert gallons to liters.
`grams_to_ounces`()	Convert grams to ounces.
`hours_to_days`()	Convert hours to days.
`joules_to_btus`()	Convert joules to BTUs.
`joules_to_calories`()	Convert joules to calories.
`joules_to_kwh`()	Convert joules to kilowatt-hours.
`joules_to_therms`()	Convert joules to therms.
`kelvin_to_celsius_`()	Convert Kelvin to Celsius.
`kelvin_to_rankine`()	Convert Kelvin to Rankine.
`kilograms_to_grams`()	Convert kilograms to grams.
`kilograms_to_pounds`()	Convert kilograms to pounds.
`kilograms_to_stones`()	Convert kilograms to stones.
`kilometers_to_miles`()	Convert kilometers to miles.
`kph_to_mph`()	Convert kilometers per hour to miles per hour.
`kph_to_mps`()	Convert kilometers per hour to meters per second.
`liters_to_cubic_meters`()	Convert liters to cubic meters.
`liters_to_gallons`()	Convert liters to gallons.
`liters_to_milliliters`()	Convert liters to milliliters.
`meters_to_feet`()	Convert meters to feet.
`meters_to_kilometers`()	Convert meters to kilometers.
`meters_to_light_years`()	Convert meters to light years.
`meters_to_nautical_miles`()	Convert meters to nautical miles.
`meters_to_yards`()	Convert meters to yards.
`milliliters_to_fluid_ounces`()	Convert milliliters to US fluid ounces.
`mps_to_knots`()	Convert meters per second to knots.
`mps_to_kph`()	Convert meters per second to kilometers per hour.
`pascals_to_atm`()	Convert Pascals to atmospheres.
`pascals_to_bar`()	Convert Pascals to bar.
`pascals_to_torr`()	Convert Pascals to torr.
`pounds_to_kilograms`()	Convert pounds to kilograms.
`psi_to_pascals`()	Convert psi to Pascals.
`rankine_to_kelvin`()	Convert Rankine to Kelvin.
`sec_to_hours`()	Convert seconds to hours.
`sec_to_minutes`()	Convert seconds to minutes.
`sq_feet_to_sq_meters`()	Convert square feet to square meters.
`sq_meters_to_acres`()	Convert square meters to acres.
`sq_meters_to_hectares`()	Convert square meters to hectares.
`sq_meters_to_sq_feet`()	Convert square meters to square feet.
`yards_to_meters`()	Convert yards to meters.

bytes_to_bits() → Expr[source]#: Convert bytes to bits.

bytes_to_gigabytes() → Expr[source]#: Convert bytes to gigabytes.

bytes_to_kilobytes() → Expr[source]#: Convert bytes to kilobytes.

bytes_to_megabytes() → Expr[source]#: Convert bytes to megabytes.

bytes_to_terabytes() → Expr[source]#: Convert bytes to terabytes.

calories_to_joules() → Expr[source]#: Convert calories to joules.

celsius_to_fahrenheit() → Expr[source]#: Convert Celsius to Fahrenheit.

celsius_to_kelvin() → Expr[source]#: Convert Celsius to Kelvin.

centimeters_to_inches() → Expr[source]#: Convert centimeters to inches.

days_to_weeks() → Expr[source]#: Convert days to weeks.

days_to_years() → Expr[source]#: Convert days to years (approx, 365 days).

fahrenheit_to_celsius() → Expr[source]#

Convert Fahrenheit to Celsius.

Examples

import polars as pl
import polars_extensions as plx

df = pl.DataFrame({
    "temp_F": [32, 68, 104],
})
df.with_columns([
    pl.col("temp_F").unit_ext.fahrenheit_to_celsius().alias("temp_C"),
])

shape: (3, 2)
┌────────┬────────┐
│ temp_F ┆ temp_C │
│ ---    ┆ ---    │
│ i64    ┆ f64    │
╞════════╪════════╡
│ 32     ┆ 0.0    │
│ 68     ┆ 20.0   │
│ 104    ┆ 40.0   │
└────────┴────────┘

gallons_to_liters() → Expr[source]#: Convert gallons to liters.

grams_to_ounces() → Expr[source]#: Convert grams to ounces.

hours_to_days() → Expr[source]#: Convert hours to days.

joules_to_btus() → Expr[source]#: Convert joules to BTUs.

joules_to_calories() → Expr[source]#: Convert joules to calories.

joules_to_kwh() → Expr[source]#: Convert joules to kilowatt-hours.

joules_to_therms() → Expr[source]#: Convert joules to therms.

kelvin_to_celsius_() → Expr[source]#: Convert Kelvin to Celsius.

kelvin_to_rankine() → Expr[source]#: Convert Kelvin to Rankine.

kilograms_to_grams() → Expr[source]#: Convert kilograms to grams.

kilograms_to_pounds() → Expr[source]#: Convert kilograms to pounds.

kilograms_to_stones() → Expr[source]#: Convert kilograms to stones.

kilometers_to_miles() → Expr[source]#: Convert kilometers to miles.

kph_to_mph() → Expr[source]#: Convert kilometers per hour to miles per hour.

kph_to_mps() → Expr[source]#: Convert kilometers per hour to meters per second.

liters_to_cubic_meters() → Expr[source]#: Convert liters to cubic meters.

liters_to_gallons() → Expr[source]#: Convert liters to gallons.

liters_to_milliliters() → Expr[source]#: Convert liters to milliliters.

meters_to_feet() → Expr[source]#: Convert meters to feet.

meters_to_kilometers() → Expr[source]#: Convert meters to kilometers.

meters_to_light_years() → Expr[source]#: Convert meters to light years.

meters_to_nautical_miles() → Expr[source]#: Convert meters to nautical miles.

meters_to_yards() → Expr[source]#: Convert meters to yards.

milliliters_to_fluid_ounces() → Expr[source]#: Convert milliliters to US fluid ounces.

mps_to_knots() → Expr[source]#: Convert meters per second to knots.

mps_to_kph() → Expr[source]#: Convert meters per second to kilometers per hour.

pascals_to_atm() → Expr[source]#: Convert Pascals to atmospheres.

pascals_to_bar() → Expr[source]#: Convert Pascals to bar.

pascals_to_torr() → Expr[source]#: Convert Pascals to torr.

pounds_to_kilograms() → Expr[source]#: Convert pounds to kilograms.

psi_to_pascals() → Expr[source]#: Convert psi to Pascals.

rankine_to_kelvin() → Expr[source]#: Convert Rankine to Kelvin.

sec_to_hours() → Expr[source]#: Convert seconds to hours.

sec_to_minutes() → Expr[source]#: Convert seconds to minutes.

sq_feet_to_sq_meters() → Expr[source]#: Convert square feet to square meters.

sq_meters_to_acres() → Expr[source]#: Convert square meters to acres.

sq_meters_to_hectares() → Expr[source]#: Convert square meters to hectares.

sq_meters_to_sq_feet() → Expr[source]#: Convert square meters to square feet.

yards_to_meters() → Expr[source]#

Convert yards to meters.

Examples

import polars as pl
import polars_extensions as plx

df = pl.DataFrame({
    "yards": [10, 50, 100]
})

df.with_columns([
    pl.col("yards").unit_ext.yards_to_meters().alias("meters")
])

shape: (3, 2)
┌───────┬────────┐
│ yards ┆ meters │
│ ---   ┆ ---    │
│ i64   ┆ f64    │
╞═══════╪════════╡
│ 10    ┆ 9.144  │
│ 50    ┆ 45.72  │
│ 100   ┆ 91.44  │
└───────┴────────┘