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 MolarFlow, Length, Temperature, Pressure
>>> f = MolarFlow(3)
>>> f
<MolarFlow(3, 'kmol/s')>
>>> f.value, f.unit
(3, <Unit('kmol/s')>)
>>> f.to('kmol/h')
<MolarFlow(10800.0, 'kmol/h')>
>>> Length(100, 'cm') == Length(1000, 'mm')
True
>>> Temperature('100C')
<Temperature(1, 'C')>
>>> 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:

>>> from z_units import Pressure
>>> # Define source environment
>>> Pressure(100, 'kPag', atm_pressure=50e3).to('kPa')
<Pressure(150.0, 'kPa')>
>>> # Define target environment
>>> Pressure(150, 'kPa').to('kPag', atm_pressure=50e3)
<Pressure(100.0, 'kPag')>
>>> # Convert between different local environments
>>> Pressure(1, 'MPag', atm_pressure=1e5).to('MPag', atm_pressure=2e5)
<Pressure(0.9, 'MPag')>

Using global configuration:

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

Unit Formatting

Multiple formatting styles are supported:

>>> from z_units import MolarEntropy
>>> x = 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.4.0.tar.gz (29.5 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.4.0-py3-none-any.whl (15.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: z_units-0.4.0.tar.gz
  • Upload date:
  • Size: 29.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","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.4.0.tar.gz
Algorithm Hash digest
SHA256 8fb4c4dddfa534959d56bda4848fedb449de72ef3b89479261589c70ebb34aed
MD5 a70af6204331007b5e8c59e3bbb17c8b
BLAKE2b-256 73f5bf8fc6d99254f74a6c0cb709202372b70db33c5d00a687ec4615452750d6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: z_units-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 15.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","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.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ac741fbfd01182356a73511402e98c79b15ab089783f490715ac1f05c92c33c2
MD5 f9ccbcd935b05beb219e76c7736c2ec3
BLAKE2b-256 8a8350f5e2d80087d86cc1b8ee79622e80ab788fefbbba7c9e558cd7286b5df9

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