Routing

Tutorials

• Tutorial: Routing Pipes Through a CAD Assembly
  • Prerequisites
  • Step 1 — Load the CAD Model
  • Step 2 — Define Weighting Rules
  • Step 3 — Wrap Volumes as RuledVolumes
  • Step 4 — Define Pipe Types
  • Step 5 — Define Ports
  • Step 6 — Create Specifications
  • Step 7 — Build the CadMap
  • Step 8 — Find Routing Paths
  • Step 9 — Access Results
  • Step 10 — Optimize Path Geometry (optional)
  • Full Script
  • Next Steps
• Tutorial: Engineering Design Rules
  • Overview
  • WeightingRule
  • TurnPenalizer
  • DistanceAttributeToggler
  • GravityRule
  • StraightLengthRule
  • ClampingConstraint
  • Custom Constraint Rules
  • Branch-Distance Rules
  • Putting It All Together
  • Next Steps
• Tutorial: Routing Zones
  • Overview
  • Creating Shapes
  • Attractive Zone
  • Repulsive Zone
  • Forbidden Zone
  • Forced Zone
  • Combining Multiple Zones
  • Complete Example
  • Next Steps
• Tutorial: Tees — Tapping a Routed Conduit
  • Overview
  • Declaring a Tee
  • Where a Tee Taps
  • Automatic Mode
  • Picking a Site
  • Holding the Cycle by Hand
  • Reading the Result
  • Good to Know
  • Complete Example
  • Next Steps
• Tutorial: 3D Pathfinding with routing.pathfinding
  • Part 1 — Basic A* in a 3D Grid
  • Part 2 — Connecting Multiple Grids
  • Available Finders
  • Loading Large Maps
  • Next Steps
• Tutorial: Smoother Paths with Theta*
  • When to Use Theta*
  • Basic Usage
  • Comparing A* and Theta*
  • Heuristic Choice
  • Using Theta* in the Full Routing Pipeline
  • Next Steps
• Tutorial: Importing Ports from Excel
  • Excel Format
  • Reading Ports from a File
  • Pairing Ports into Specifications
  • Next Steps
• Tutorial: Defining Specifications in a Spreadsheet
  • The Data Model: Two Tables
  • Loading from Excel (.xlsx)
  • Loading from CSV
  • Routing the Loaded Specifications
  • Column Reference: pipe_types
  • Column Reference: specifications
  • Example Data
  • Next Steps
• Tutorial: Routing in Large Spaces with Obstacles
  • Assembly Structure
  • Choosing Voxel Size for Large Assemblies
  • Building and Decomposing the CadMap
  • Routing and Optimization
  • Memory and Performance Tips
  • Next Steps
• Tutorial: Routing Inside a Closed Volume
  • The voxel_inside Flag
  • Shared Setup
  • Routing Outside the Cube (default)
  • Routing Through the Cube (voxel_inside=True)
  • Next Steps

User Guide

• User Guide: Installation
  • Requirements
  • From PyPI (recommended)
  • From Source (development)
  • Dependencies
  • Upgrading
  • Checking the Installation
• Migrating to v3.0.0
  • Requirements
  • Design rules of your own need no change
  • MultiCadMap gives way to the regions of CadMap
  • One voxelization type: RoutingVoxelization
  • Coordinate conversions move to VoxelFrame
  • routing.pathfinding is a compiled engine
  • Pipe lines live in world coordinates
  • Pack construction changed
  • Trays rest on flagged volumes
  • PoolingRule prices loops, on corridor labels
  • Zones by kind replace ShapedWeightingRule
  • A conduit no route joins is kept, not raised
  • OptimizedPipes and OptimizedPipe become Alternative and Refinement
  • Solution joins terminals
  • best_pipe is the geometry the checks accepted
  • Solutions are named after their specification
  • Pass name by keyword
  • Removed helpers
  • Behaviour changes without an API change
  • Also new
  • See Also
• Migrating to v2.12
  • New: harness generation
  • pymoo and scikit-image are new dependencies
  • voxel_inside was removed from CadMap.from_project_inputs
  • to_matrix_based_voxelization is now revoxelize
  • RoomVoxelization moved to routing.core.voxels
  • Pack construction and stamping changed
  • Removed helpers
  • Behaviour changes without an API change
  • Also new in v2.12
  • See Also
• Migrating to v2.11
  • Python 3.12 is now required
  • piping_3d is now bundled as routing.core.legacy_piping
  • routing.model.Object3D was removed
  • zarr dependency dropped
  • New in v2.11
  • See Also
• User Guide: Core Concepts
  • Overview
  • Port
  • PipeType
  • Specification
  • RoutePlanning
  • RuledVolume
  • CadMap
  • RoutePlanner
  • RoutingResults
  • Next Steps
• User Guide: Design Rules Reference
  • Where to Attach Rules
  • WeightingRule
  • TurnPenalizer
  • CostRule (base class)
  • DistanceAttributeToggler
  • GravityRule
  • StraightLengthRule
  • ClampingConstraint
  • Zones: WeightedZone, ForbiddenZone, ForcedZone
  • PoolingRule
  • BranchPortDistanceRule
  • BranchClampDistanceRule
  • Design Rules on the Harness
  • ConstraintRule (base class)
• User Guide: Pipe Pooling (Bundling)
  • How Pooling Works
  • PoolingMode
  • PoolingSpecification
  • PoolingRule
  • Parallel Packs: Trays
  • Loops: Leaving and Rejoining a Harness
  • Pipe Ordering Matters
  • Accessing Pack Results
  • Complete Example
  • Next Steps
• User Guide: Path Geometry Optimization
  • How the Optimizer Works
  • Costs
  • Settings
  • Running the Optimizer
  • Displaying Optimized Results
  • Choosing voxel_size for Optimization
  • Complete Example
  • Next Steps
• User Guide: Harness Generation
  • The Pipeline
  • One Call
  • HarnessSettings
  • The Stages
  • Skeletonization
  • GA Recipes
  • Reading the Result
  • Driving the Stages by Hand
  • Design Rules on the Harness
  • Custom Optimization Terms
  • Replaying a Run
  • Bundling Without Optimizing
  • Tuning Guide
  • Next Steps
• User Guide: Multi-Scale and Multi-Grid Routing
  • Regions of a CadMap
  • Decomposing a CadMap
  • Routing a Decomposed Map
  • Visualizing the Multi-Grid Layout
  • Complete Multi-Scale Example
  • Design Rules Across Grids
  • When to Use Multi-Scale vs Multi-Grid
  • Next Steps
• User Guide: The routing.pathfinding Module
  • Module Structure
  • SmartGrid
  • Nodes
  • DiagonalMovement
  • Heuristics
  • Available Finders
  • Running a Search
  • Design Rules in the Search
  • SmartWorld (Multi-Grid)
  • SmartFinder
  • Performance Tips
  • Next Steps
• User Guide: Accessing Routing Results
  • RoutingResults Object
  • Visualizing Generated Paths
  • Visualizing Optimized Paths
  • 3D CAD View with Packs
  • Bifurcation Points
  • Alternatives, Refinements and the Pick
  • Complete Inspection Example
  • Next Steps
• User Guide: Verbose Logging
  • Quick Start
  • Verbosity Levels
  • Saving Logs to a File
  • Typical Workflow
• User Guide: Routing Workflows
  • Typical Workflow Structure
  • Workflow JSON Files
  • Next Steps

Examples

• Use Cases: Which Script to Start From
• Example Scripts

API Reference

• API Reference
  • routing.core
  • routing.pathfinding
  • routing.wires