How yunruse/noether works
Main Components
a) Core System:
• core/ directory components as the fundamental building blocks:
• Measure (handling measurements)
• Unit (base unit definitions)
• Dimension (dimensional analysis)
• Catalogue (unit registry)
• Handler (output formatting)
b) Unit Types Layer:
• Different unit implementations from core/units/:
• Linear Units
• Affine Units
• Geometric Units
• Logarithmic Units
• Prefixed Units
c) Catalogue Layer:
• Extensive unit catalogue into categories:
• Scientific (SI, CGS, astronomy, constants)
• Conventional
• Historic
• Humorous
d) Interface Layer:
• CLI Interface
• Python API
• System
• Configuration Handler
Relationships and Data Flow
• User input flow through either CLI or Python API
• Unit conversion pathways
• Catalogue lookup operations
• Formatting process
Specific Implementation Details
• Input parsing system (_tokenizers.py)
• Unit conversion logic (Multiplication.py)
• Configuration management (config.py)
• Error handling (errors.py)
External Integrations (Planned)
• Planned integrations with:
• GNU units
• NumPy
• Matplotlib
The configuration system that allows customization
Key Architectural Patterns to Highlight:
Facade Pattern (for simple API access)
• Diamond endings: Composition relationships
• Rectangles: Core components
• Rounded rectangles: Interfaces
• Hexagons: External systems
Level of Detail:
Conversion Pipeline
Remember to include version information (Python 3.10+ requirement) and note the planned future integrations as part of the system's evolution.