UnitFlow Documentation

UnitFlow is an engineering math library for Python: unit algebra, dimensional reasoning, symbolic constraints, and optional NumPy integration.

Documentation and the broader ThunderGraph ecosystem: thundergraph.ai.

User

• Install
  • Requirements
  • From PyPI
  • Verify
  • Documentation
  • Develop from a clone
• Overview
  • What you use it for
  • Relationship to ThunderGraph
  • Next steps
• Quickstart
  • Quantities and conversion
  • Symbols and equations
  • Evaluate an expression
  • Numeric compilation (solvers)
• Units and quantities
  • Dimensions and semantic equality
  • Exact scales and π
  • Quantities
  • Quantity kinds (torque vs energy)
  • User-defined units
• Symbolic constraints
  • Symbols
  • Equations and inequalities
  • free_symbols
  • Evaluation
  • Numeric compilation
• NumPy integration
• Serialization
  • Limitations

Developer

• Architecture
  • Dependency rules
• Repository map
• Contributing
• Contributing to UnitFlow
  • Code of Conduct
  • Getting Started
  • Development Expectations
  • Architecture Guidelines
  • Adding New Units
  • Adding New Catalogs
  • Reporting Issues
  • License
• Testing
  • Layout
  • Lint and types
  • Documentation build
• Releasing
  • Build artifacts
  • PyPI
  • Documentation

API Reference

• API Reference
  • unitflow.core
  • unitflow.expr
  • unitflow.define
  • unitflow.catalogs
  • unitflow.serialization
  • unitflow.backends