qnty 0.0.8__tar.gz → 0.1.0__tar.gz

qnty-0.1.0/PKG-INFO

@@ -0,0 +1,199 @@
+Metadata-Version: 2.3
+Name: qnty
+Version: 0.1.0
+Summary: High-performance unit system library for Python with dimensional safety and fast unit conversions
+License: Apache-2.0
+Keywords: units,dimensional analysis,engineering,physics,quantities,measurements
+Author: tn3wman
+Requires-Python: >=3.11, <3.14
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Provides-Extra: benchmark
+Provides-Extra: dev
+Requires-Dist: Pint (>=0.24.4) ; extra == "benchmark"
+Requires-Dist: numpy (>=2.3.2)
+Requires-Dist: pytest (>=8.4.1) ; extra == "dev"
+Requires-Dist: ruff (>=0.1.0) ; extra == "dev"
+Project-URL: Bug Tracker, https://github.com/tn3wman/qnty/issues
+Project-URL: Documentation, https://github.com/tn3wman/qnty#readme
+Project-URL: Homepage, https://github.com/tn3wman/qnty
+Project-URL: Repository, https://github.com/tn3wman/qnty
+Description-Content-Type: text/markdown
+
+# Qnty
+
+**High-performance unit system library for Python with dimensional safety and fast unit conversions for engineering calculations.**
+
+[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Development Status](https://img.shields.io/badge/status-beta-orange.svg)](https://pypi.org/project/qnty/)
+
+## ⚠️ Important Disclaimer
+
+**🚧 Work in Progress**: Qnty is currently in active development and has not been thoroughly vetted for production engineering calculations. While we strive for accuracy, this library should not be used for critical engineering applications without independent verification.
+
+**📐 Accuracy Notice**: The authors are not responsible or liable for incorrect results, calculation errors, or any consequences arising from the use of this library. Always validate calculations independently using established engineering tools and practices.
+
+*Use Qnty to help prevent unit errors, but always verify critical calculations through multiple methods.*
+
+---
+
+## ✨ Key Features
+
+- **🚀 Ultra-Fast Performance**: Prime number encoding and pre-computed conversion tables
+- **🛡️ Type Safety**: Compile-time dimensional analysis prevents unit errors
+- **⚡ Zero-Cost Abstractions**: Optimized operations with `__slots__` and caching
+- **🔗 Fluent API**: Intuitive method chaining for readable code
+- **🧮 Engineering-Focused**: Built for real-world engineering calculations
+- **🧬 Mathematical System**: Built-in equation solving and expression trees
+- **📊 Comprehensive Testing**: 187 tests with performance benchmarks
+
+## 🚀 Quick Start
+
+### Installation
+
+```bash
+pip install qnty
+```
+
+### Basic Usage
+
+```python
+from qnty import Length, Pressure, Area
+
+# Create quantities with dimensional safety
+width = Length(3, "meter", "Width")
+height = Length(2, "meter", "Height")
+
+# Solve mathematical expressions
+area = Area("area", is_known=False)
+area.solve_from(width * height)
+print(f"Area: {area}")  # Area: 6.0 m²
+```
+
+### Engineering Example
+
+```python
+from qnty import Problem, Length, Pressure
+
+class PipeThickness(Problem):
+    """Calculate pipe wall thickness"""
+    
+    # Known parameters
+    pressure = Pressure(150, "pound_force_per_square_inch", "Internal Pressure")
+    diameter = Length(6, "inch", "Pipe Diameter")
+    allowable_stress = Pressure(20000, "pound_force_per_square_inch", "Allowable Stress")
+    
+    # Unknown to solve for
+    thickness = Length("thickness", is_known=False)
+    
+    # Engineering equation: t = (P × D) / (2 × S)
+    equation = thickness.equals((pressure * diameter) / (2 * allowable_stress))
+
+# Solve the problem
+problem = PipeThickness()
+problem.solve()
+print(f"Required thickness: {problem.thickness}")
+```
+
+### Mathematical Operations
+
+```python
+from qnty import Length, sqrt, Area
+
+# Dimensional analysis with mathematical functions
+area = Area(25, "square_meter", "Square Area")
+side = Length("side", is_known=False)
+side.solve_from(sqrt(area))  # Returns Length, not Area!
+print(f"Side length: {side}")  # Side length: 5.0 m
+```
+
+## 📚 Documentation
+
+- **[📖 Tutorial](docs/TUTORIAL.md)** - Step-by-step learning guide
+- **[📋 API Reference](docs/API_REFERENCE.md)** - Complete API documentation
+- **[🏗️ Examples](examples/)** - Real-world engineering examples
+- **[📁 Full Documentation](docs/)** - Complete documentation index
+
+## 🚀 Performance
+
+Qnty significantly outperforms other unit libraries with **18.9x average speedup** over Pint:
+
+| Operation | Qnty | Pint | **Speedup** |
+|-----------|------|------|-------------|
+| Mixed Unit Addition | 0.76 μs | 17.52 μs | **23.1x** |
+| Complex ASME Equation | 4.07 μs | 106.17 μs | **26.1x** 🚀 |
+| Type-Safe Variables | 0.98 μs | 9.65 μs | **9.8x** |
+| **AVERAGE** | **1.89 μs** | **35.83 μs** | **18.9x** 🏆 |
+
+*Run `pytest tests/test_benchmark.py -v -s` to verify on your system.*
+
+## 🧮 100+ Engineering Quantities
+
+Qnty provides comprehensive coverage of engineering domains:
+
+```python
+from qnty import (
+    # Mechanical
+    Length, Area, Volume, Mass, Force, Pressure, Temperature,
+    # Electrical  
+    ElectricPotential, ElectricCurrentIntensity, ElectricResistance,
+    # Thermal
+    ThermalConductivity, HeatTransferCoefficient,
+    # Fluid Dynamics
+    ViscosityDynamic, MassFlowRate, VolumetricFlowRate,
+    # And 80+ more...
+)
+```
+
+## 🔧 Development
+
+```bash
+# Install dependencies
+pip install -r requirements.txt
+
+# Run tests
+pytest
+
+# Run specific test
+pytest tests/test_dimension.py -v
+
+# Run benchmarks
+python tests/test_benchmark.py
+
+# Lint code
+ruff check src/ tests/
+ruff format src/ tests/
+```
+
+## 📄 License
+
+This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
+
+## 🤝 Contributing
+
+We welcome contributions! Please see [CLAUDE.md](CLAUDE.md) for development guidelines and:
+
+1. Fork the repository
+2. Create a feature branch
+3. Add tests for new functionality
+4. Ensure all tests pass: `pytest`
+5. Submit a pull request
+
+---
+
+**Ready to supercharge your engineering calculations?** 🚀
+
+- Start with the **[Tutorial](docs/TUTORIAL.md)**
+- Browse the **[API Reference](docs/API_REFERENCE.md)**
+- Try the **[Examples](examples/)**
+

qnty-0.1.0/README.md

@@ -0,0 +1,167 @@
+# Qnty
+
+**High-performance unit system library for Python with dimensional safety and fast unit conversions for engineering calculations.**
+
+[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Development Status](https://img.shields.io/badge/status-beta-orange.svg)](https://pypi.org/project/qnty/)
+
+## ⚠️ Important Disclaimer
+
+**🚧 Work in Progress**: Qnty is currently in active development and has not been thoroughly vetted for production engineering calculations. While we strive for accuracy, this library should not be used for critical engineering applications without independent verification.
+
+**📐 Accuracy Notice**: The authors are not responsible or liable for incorrect results, calculation errors, or any consequences arising from the use of this library. Always validate calculations independently using established engineering tools and practices.
+
+*Use Qnty to help prevent unit errors, but always verify critical calculations through multiple methods.*
+
+---
+
+## ✨ Key Features
+
+- **🚀 Ultra-Fast Performance**: Prime number encoding and pre-computed conversion tables
+- **🛡️ Type Safety**: Compile-time dimensional analysis prevents unit errors
+- **⚡ Zero-Cost Abstractions**: Optimized operations with `__slots__` and caching
+- **🔗 Fluent API**: Intuitive method chaining for readable code
+- **🧮 Engineering-Focused**: Built for real-world engineering calculations
+- **🧬 Mathematical System**: Built-in equation solving and expression trees
+- **📊 Comprehensive Testing**: 187 tests with performance benchmarks
+
+## 🚀 Quick Start
+
+### Installation
+
+```bash
+pip install qnty
+```
+
+### Basic Usage
+
+```python
+from qnty import Length, Pressure, Area
+
+# Create quantities with dimensional safety
+width = Length(3, "meter", "Width")
+height = Length(2, "meter", "Height")
+
+# Solve mathematical expressions
+area = Area("area", is_known=False)
+area.solve_from(width * height)
+print(f"Area: {area}")  # Area: 6.0 m²
+```
+
+### Engineering Example
+
+```python
+from qnty import Problem, Length, Pressure
+
+class PipeThickness(Problem):
+    """Calculate pipe wall thickness"""
+    
+    # Known parameters
+    pressure = Pressure(150, "pound_force_per_square_inch", "Internal Pressure")
+    diameter = Length(6, "inch", "Pipe Diameter")
+    allowable_stress = Pressure(20000, "pound_force_per_square_inch", "Allowable Stress")
+    
+    # Unknown to solve for
+    thickness = Length("thickness", is_known=False)
+    
+    # Engineering equation: t = (P × D) / (2 × S)
+    equation = thickness.equals((pressure * diameter) / (2 * allowable_stress))
+
+# Solve the problem
+problem = PipeThickness()
+problem.solve()
+print(f"Required thickness: {problem.thickness}")
+```
+
+### Mathematical Operations
+
+```python
+from qnty import Length, sqrt, Area
+
+# Dimensional analysis with mathematical functions
+area = Area(25, "square_meter", "Square Area")
+side = Length("side", is_known=False)
+side.solve_from(sqrt(area))  # Returns Length, not Area!
+print(f"Side length: {side}")  # Side length: 5.0 m
+```
+
+## 📚 Documentation
+
+- **[📖 Tutorial](docs/TUTORIAL.md)** - Step-by-step learning guide
+- **[📋 API Reference](docs/API_REFERENCE.md)** - Complete API documentation
+- **[🏗️ Examples](examples/)** - Real-world engineering examples
+- **[📁 Full Documentation](docs/)** - Complete documentation index
+
+## 🚀 Performance
+
+Qnty significantly outperforms other unit libraries with **18.9x average speedup** over Pint:
+
+| Operation | Qnty | Pint | **Speedup** |
+|-----------|------|------|-------------|
+| Mixed Unit Addition | 0.76 μs | 17.52 μs | **23.1x** |
+| Complex ASME Equation | 4.07 μs | 106.17 μs | **26.1x** 🚀 |
+| Type-Safe Variables | 0.98 μs | 9.65 μs | **9.8x** |
+| **AVERAGE** | **1.89 μs** | **35.83 μs** | **18.9x** 🏆 |
+
+*Run `pytest tests/test_benchmark.py -v -s` to verify on your system.*
+
+## 🧮 100+ Engineering Quantities
+
+Qnty provides comprehensive coverage of engineering domains:
+
+```python
+from qnty import (
+    # Mechanical
+    Length, Area, Volume, Mass, Force, Pressure, Temperature,
+    # Electrical  
+    ElectricPotential, ElectricCurrentIntensity, ElectricResistance,
+    # Thermal
+    ThermalConductivity, HeatTransferCoefficient,
+    # Fluid Dynamics
+    ViscosityDynamic, MassFlowRate, VolumetricFlowRate,
+    # And 80+ more...
+)
+```
+
+## 🔧 Development
+
+```bash
+# Install dependencies
+pip install -r requirements.txt
+
+# Run tests
+pytest
+
+# Run specific test
+pytest tests/test_dimension.py -v
+
+# Run benchmarks
+python tests/test_benchmark.py
+
+# Lint code
+ruff check src/ tests/
+ruff format src/ tests/
+```
+
+## 📄 License
+
+This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
+
+## 🤝 Contributing
+
+We welcome contributions! Please see [CLAUDE.md](CLAUDE.md) for development guidelines and:
+
+1. Fork the repository
+2. Create a feature branch
+3. Add tests for new functionality
+4. Ensure all tests pass: `pytest`
+5. Submit a pull request
+
+---
+
+**Ready to supercharge your engineering calculations?** 🚀
+
+- Start with the **[Tutorial](docs/TUTORIAL.md)**
+- Browse the **[API Reference](docs/API_REFERENCE.md)**
+- Try the **[Examples](examples/)**

{qnty-0.0.8 → qnty-0.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "qnty"
-version = "0.0.8"
+version = "0.1.0"
 description = "High-performance unit system library for Python with dimensional safety and fast unit conversions"
 readme = "README.md"
 license = { text = "Apache-2.0" }

qnty-0.1.0/src/qnty/__init__.py

@@ -0,0 +1,255 @@
+"""
+Qnty - High-Performance Unit System for Engineering
+====================================================
+
+A fast, type-safe unit system library for Python with dimensional safety and optimized unit conversions for engineering calculations.
+"""
+
+# from . import (quantity, expressions)
+
+from .expressions import (
+    abs_expr,
+    cond_expr,
+    cos,
+    exp,
+    ln,
+    log10,
+    max_expr,
+    min_expr,
+    sin,
+    sqrt,
+    tan,
+)
+from .problems import Problem
+from .quantities.field_vars import (
+    AbsorbedDose,
+    Acceleration,
+    ActivationEnergy,
+    AmountOfSubstance,
+    AnglePlane,
+    AngleSolid,
+    AngularAcceleration,
+    AngularMomentum,
+    Area,
+    AreaPerUnitVolume,
+    AtomicWeight,
+    Concentration,
+    Dimensionless,
+    DynamicFluidity,
+    ElectricalConductance,
+    ElectricalPermittivity,
+    ElectricalResistivity,
+    ElectricCapacitance,
+    ElectricCharge,
+    ElectricCurrentIntensity,
+    ElectricDipoleMoment,
+    ElectricFieldStrength,
+    ElectricInductance,
+    ElectricPotential,
+    ElectricResistance,
+    EnergyFlux,
+    EnergyHeatWork,
+    EnergyPerUnitArea,
+    Force,
+    ForceBody,
+    ForcePerUnitMass,
+    FrequencyVoltageRatio,
+    FuelConsumption,
+    HeatOfCombustion,
+    HeatOfFusion,
+    HeatOfVaporization,
+    HeatTransferCoefficient,
+    Illuminance,
+    KineticEnergyOfTurbulence,
+    Length,
+    LinearMassDensity,
+    LinearMomentum,
+    LuminanceSelf,
+    LuminousFlux,
+    LuminousIntensity,
+    MagneticField,
+    MagneticFlux,
+    MagneticInductionFieldStrength,
+    MagneticMoment,
+    MagneticPermeability,
+    MagnetomotiveForce,
+    Mass,
+    MassDensity,
+    MassFlowRate,
+    MassFlux,
+    MassFractionOfI,
+    MassTransferCoefficient,
+    MolalityOfSoluteI,
+    MolarConcentrationByMass,
+    MolarFlowRate,
+    MolarFlux,
+    MolarHeatCapacity,
+    MolarityOfI,
+    MoleFractionOfI,
+    MomentOfInertia,
+    MomentumFlowRate,
+    MomentumFlux,
+    NormalityOfSolution,
+    ParticleDensity,
+    Percent,
+    Permeability,
+    PhotonEmissionRate,
+    PowerPerUnitMass,
+    PowerPerUnitVolume,
+    PowerThermalDuty,
+    Pressure,
+    RadiationDoseEquivalent,
+    RadiationExposure,
+    Radioactivity,
+    SecondMomentOfArea,
+    SecondRadiationConstantPlanck,
+    SpecificEnthalpy,
+    SpecificGravity,
+    SpecificHeatCapacityConstantPressure,
+    SpecificLength,
+    SpecificSurface,
+    SpecificVolume,
+    Stress,
+    SurfaceMassDensity,
+    SurfaceTension,
+    Temperature,
+    ThermalConductivity,
+    Time,
+    Torque,
+    TurbulenceEnergyDissipationRate,
+    VelocityAngular,
+    VelocityLinear,
+    ViscosityDynamic,
+    ViscosityKinematic,
+    Volume,
+    VolumeFractionOfI,
+    VolumetricCalorificHeatingValue,
+    VolumetricCoefficientOfExpansion,
+    VolumetricFlowRate,
+    VolumetricFlux,
+    VolumetricMassFlowRate,
+    Wavenumber,
+)
+
+# Define public API
+__all__ = [
+    "abs_expr",
+    "min_expr",
+    "max_expr",
+    "cond_expr",
+    "sin",
+    "cos",
+    "tan",
+    "sqrt",
+    "ln",
+    "log10",
+    "exp",
+    "Problem",
+    "AbsorbedDose",
+    "Acceleration",
+    "ActivationEnergy",
+    "AmountOfSubstance",
+    "AnglePlane",
+    "AngleSolid",
+    "AngularAcceleration",
+    "AngularMomentum",
+    "Area",
+    "AreaPerUnitVolume",
+    "AtomicWeight",
+    "Concentration",
+    "Dimensionless",
+    "DynamicFluidity",
+    "ElectricalConductance",
+    "ElectricalPermittivity",
+    "ElectricalResistivity",
+    "ElectricCapacitance",
+    "ElectricCharge",
+    "ElectricCurrentIntensity",
+    "ElectricDipoleMoment",
+    "ElectricFieldStrength",
+    "ElectricInductance",
+    "ElectricPotential",
+    "ElectricResistance",
+    "EnergyFlux",
+    "EnergyHeatWork",
+    "EnergyPerUnitArea",
+    "Force",
+    "ForceBody",
+    "ForcePerUnitMass",
+    "FrequencyVoltageRatio",
+    "FuelConsumption",
+    "HeatOfCombustion",
+    "HeatOfFusion",
+    "HeatOfVaporization",
+    "HeatTransferCoefficient",
+    "Illuminance",
+    "KineticEnergyOfTurbulence",
+    "Length",
+    "LinearMassDensity",
+    "LinearMomentum",
+    "LuminanceSelf",
+    "LuminousFlux",
+    "LuminousIntensity",
+    "MagneticField",
+    "MagneticFlux",
+    "MagneticInductionFieldStrength",
+    "MagneticMoment",
+    "MagneticPermeability",
+    "MagnetomotiveForce",
+    "Mass",
+    "MassDensity",
+    "MassFlowRate",
+    "MassFlux",
+    "MassFractionOfI",
+    "MassTransferCoefficient",
+    "MolalityOfSoluteI",
+    "MolarConcentrationByMass",
+    "MolarFlowRate",
+    "MolarFlux",
+    "MolarHeatCapacity",
+    "MolarityOfI",
+    "MoleFractionOfI",
+    "MomentOfInertia",
+    "MomentumFlowRate",
+    "MomentumFlux",
+    "NormalityOfSolution",
+    "ParticleDensity",
+    "Percent",
+    "Permeability",
+    "PhotonEmissionRate",
+    "PowerPerUnitMass",
+    "PowerPerUnitVolume",
+    "PowerThermalDuty",
+    "Pressure",
+    "RadiationDoseEquivalent",
+    "RadiationExposure",
+    "Radioactivity",
+    "SecondMomentOfArea",
+    "SecondRadiationConstantPlanck",
+    "SpecificEnthalpy",
+    "SpecificGravity",
+    "SpecificHeatCapacityConstantPressure",
+    "SpecificLength",
+    "SpecificSurface",
+    "SpecificVolume",
+    "Stress",
+    "SurfaceMassDensity",
+    "SurfaceTension",
+    "Temperature",
+    "ThermalConductivity",
+    "Time",
+    "Torque",
+    "TurbulenceEnergyDissipationRate",
+    "VelocityAngular",
+    "VelocityLinear",
+    "ViscosityDynamic",
+    "ViscosityKinematic",
+    "Volume",
+    "VolumeFractionOfI",
+    "VolumetricCalorificHeatingValue",
+    "VolumetricCoefficientOfExpansion",
+    "VolumetricFlowRate",
+    "VolumetricFlux",
+    "VolumetricMassFlowRate",
+    "Wavenumber",
+]

qnty-0.1.0/src/qnty/constants/__init__.py

@@ -0,0 +1,10 @@
+"""
+Mathematical and numerical constants used throughout the qnty library.
+
+This module centralizes magic numbers and tolerances to improve maintainability
+and consistency across the codebase.
+"""
+
+from .numerical import *
+from .solvers import *
+from .tests import *

qnty-0.1.0/src/qnty/constants/numerical.py

@@ -0,0 +1,18 @@
+# Numerical tolerances for floating point comparisons
+FLOAT_EQUALITY_TOLERANCE = 1e-10
+"""Default tolerance for floating point equality comparisons."""
+
+DIVISION_BY_ZERO_THRESHOLD = 1e-15
+"""Threshold below which a value is considered effectively zero for division."""
+
+CONDITION_EVALUATION_THRESHOLD = 1e-10
+"""Threshold for evaluating conditional expressions as true/false."""
+
+DIMENSIONAL_PRECISION_TOLERANCE = 1e-10
+"""Tolerance for dimensional signature comparisons."""
+
+PREFIX_LOOKUP_TOLERANCE = 1e-10
+"""Default tolerance for SI prefix factor lookup."""
+
+PREFIX_LOOKUP_MIN_TOLERANCE = 1e-15
+"""Minimum tolerance for SI prefix factor lookup to avoid expensive searches."""

qnty-0.1.0/src/qnty/constants/solvers.py

@@ -0,0 +1,6 @@
+# Solver defaults
+SOLVER_DEFAULT_TOLERANCE = 1e-10
+"""Default numerical tolerance for equation solving convergence."""
+
+SOLVER_DEFAULT_MAX_ITERATIONS = 100
+"""Default maximum iterations for iterative solvers."""

qnty-0.1.0/src/qnty/constants/tests.py

@@ -0,0 +1,6 @@
+# Test tolerances
+TEST_PRECISION_TOLERANCE = 1e-6
+"""Tolerance used in tests for validating calculated results."""
+
+TEST_DIMENSION_TOLERANCE = 1e-10
+"""Tolerance used in tests for dimensional signature comparisons."""

qnty-0.1.0/src/qnty/dimensions/__init__.py

@@ -0,0 +1,23 @@
+"""
+Core Dimensions Module
+======================
+
+Core dimensional analysis components providing compile-time type safety.
+
+This module provides the fundamental building blocks for qnty's dimensional analysis system:
+- BaseDimension: Prime-number-encoded base dimensions
+- DimensionSignature: Ultra-fast dimensional compatibility checking
+"""
+
+from .base import BASE_DIMENSIONS, DIMENSION_SYMBOLS, PRIME_MAP, BaseDimension, DimensionConfig
+from .field_dims import *  # noqa: F403
+from .signature import DimensionSignature
+
+__all__ = (
+    "BaseDimension",
+    "DimensionSignature",
+    "DimensionConfig",
+    "BASE_DIMENSIONS",
+    "DIMENSION_SYMBOLS",
+    "PRIME_MAP"
+)