Skip to main content

A simple unit converter for chemical engineers

Project description

z-units

A simple unit-converter for chemical engineers

Features

  • Gauge pressure units (MPag, kPag, psig, ...) with configurable atmospheric pressure
  • Standard volume units (Sm³) with configurable STP conditions
  • Friendly to HYSYS users
  • Rich formatting options

Installation

pip install z-units

Quickstart

>>> from z_units import quantity as q
>>> f = q.MolarFlow(3)
>>> f
<MolarFlow(3, 'kmol/s')>
>>> f.value, f.unit
(3, <Unit('kmol/s')>)
>>> f.to('kmol/h')
<MolarFlow(10800.0, 'kmol/h')>
>>> q.Length(100, 'cm') == q.Length(1000, 'mm')
True
>>> q.Temperature('100C')
<Temperature(1, 'C')>
>>> q.Pressure(15, 'psi').to('MPag')
<Pressure(0.0020963594, 'MPag')>
>>> from z_units import convert
>>> convert(1, 'm', 'ft')
<Length(3.2808399, 'ft')>

Advanced Features

Gauge Pressure Handling

The atmospheric pressure reference (default: 101325 Pa) can be configured globally or passed as an argument locally.

Using argument locally:

>>> q.Pressure(100, 'kPa', atm_pressure=50e3).to('kPag')
<Pressure(50.0, 'kPag')>
>>> q.Pressure(100, 'kPa').to('kPag', atm_pressure=50e3)
<Pressure(50.0, 'kPag')>

Using global configuration:

>>> from z_units.environment import get_env
# Before
>>> q.Pressure(100, 'kPa').to('kPag')
<Pressure(-1.325, 'kPag')>
# Set to 100 kPa
# atmospheric_pressure in Pa
>>> env = get_env()
>>> env.atmospheric_pressure = 100e3
# After
>>> q.Pressure(100, 'kPa').to('kPag')
<Pressure(0.0, 'kPag')>

Standard Volume Units

Standard temperature and pressure (STP) conditions can be configured for standard volume conversions:

>>> from z_units.environment import get_env
# Default STP: 20°C, 101325 Pa
>>> q.Substance(100, 'Nm3').to('Sm3')
<Substance(107.321984, 'Sm3')>
# Change to 15°C, set value in K
>> > get_env().standard_temperature = 273.15 + 15
>> > q.Substance(100, 'Nm3').to('Sm3')
<Substance(105.491488, 'Sm3')>

Unit Formatting

Multiple formatting styles are supported:

>>> x = q.MolarEntropy(100)
# Only value
>>> f"{x}"
'100'
# Quick style (simplified)
>>> f"{x:q}"
'100 kJ/kmol-C'
# Python style (full)
>>> f"{x:p}"
'100 kJ/(kmol*C)'

Predefined Quantities

  • Length (m, km, cm, mm, ft, in, ...)
  • Area (m2, km2, ...)
  • Volume (m3, L, mL, ...)
  • Time (s, min, h, ...)
  • Mass (kg, g, lb, ...)
  • Force (N, kN, ...)
  • Substance (mol, kmol, ...)
  • Energy (J, kJ, kWh, ...)
  • Velocity (m/s, km/h, ...)
  • Temperature (K, C, F)
  • DeltaTemperature (K, C, F)
  • Pressure (Pa, kPa, kPag, MPa, MPag, bar, barg, psi, psig...)
  • VolumeFlow (m³/s, L/min, ...)
  • StandardGasFlow (Nm3/h, Sm3/h, ...)
  • MolarFlow (mol/s, kmol/h, ...)
  • MassFlow (kg/s, t/h, ...)
  • Density (kg/m3, g/cm3, ...)
  • MolarDensity (mol/m3, kmol/m3)
  • HeatCapacity (J/kg-K, kJ/kg-K)
  • MolarHeatCapacity (J/mol-K, kJ/kmol-K))
  • Entropy (J/kg-K), kJ/kg-K)
  • MolarEntropy (J/mol-K, kJ/kmol-K)
  • ThermalConductivity (W/m-K)
  • Viscosity (Pa-s, cP)
  • KinematicViscosity (m2/s, cSt)
  • SurfaceTension (N/m)
  • Dimensionless

Environment Configuration

Global environment parameters can be configured:

>>> from z_units.environment import get_env
# Set atmospheric pressure
>>> get_env().atmospheric_pressure = 100e3  # 100 kPa
# Set standard conditions
>>> get_env().standard_temperature = 273.15  # 0°C
>>> get_env().standard_pressure = 101325  # 1 atm
# Reset to defaults
>>> get_env().reset()

About

As a chemical engineer, the Gauge-Pressure units are very useful to me. Unfortunately those units are not supported in some popular modules, so I reinvent the wheel.

License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

z_units-0.2.1.tar.gz (31.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

z_units-0.2.1-py3-none-any.whl (14.8 kB view details)

Uploaded Python 3

File details

Details for the file z_units-0.2.1.tar.gz.

File metadata

  • Download URL: z_units-0.2.1.tar.gz
  • Upload date:
  • Size: 31.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for z_units-0.2.1.tar.gz
Algorithm Hash digest
SHA256 488ca7c641eb45da221dc43bb386ca7193c20487c5d4b558e9f5fdde125e2d98
MD5 aa295ad9622e11fd4062f72c22c8c62a
BLAKE2b-256 7581d67439468113285f5c449af7cbec6aa914e5414efdaf619a8d6867e802f8

See more details on using hashes here.

File details

Details for the file z_units-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: z_units-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 14.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for z_units-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ed8740d83da929a1d28f1a514ca686d33034b98b4de9d2c786a6451c95e933a5
MD5 53aaeca339b0a41596389a554cbc220c
BLAKE2b-256 04dcace456d3953238984b6915b914e32f79a896167ddf809436d664e22618f9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page