kumiki.joints.workshop.butt¶
Flat import path
kumiki/__init__.py re-exports everything on this page via from kumiki import *, so every name below is also available directly as kumiki.butt -- you do not need to import from the submodule path shown in the heading above.
kumiki.joints.workshop.butt
¶
Kumiki - Butt joint construction functions
cut_wedged_half_dovetail_joint_on_face_aligned_timbers
module-attribute
¶
cut_wedged_half_dovetail_joint_on_face_aligned_timbers = cut_wedged_half_dovetail_mortise_and_tenon_joint_on_face_aligned_timbers
cut_plain_butt_joint
¶
cut_plain_butt_joint(arrangement: ButtJointTimberArrangement, relief: Union[None, ButtJointScribeReliefConfig] = butt_timber()) -> Joint
Creates a butt joint where the butt timber is cut flush with the face of the receiving timber.
The butt timber's end is trimmed along the plane of the best-matching long face of the receiving timber. The receiving timber otherwise isn't cut, aside from any scribe relief.
Works for any non-parallel angle between the timbers, including oblique 3D angles. The cut plane follows the actual receiving face geometry rather than being perpendicular to the butt timber's axis, so the mating face is always flush.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
arrangement
|
ButtJointTimberArrangement
|
Butt joint arrangement with butt_timber, receiving_timber, butt_timber_end. |
required |
relief
|
Union[None, ButtJointScribeReliefConfig]
|
Scribe-relief configuration for imperfect timbers. Defaults to scribing the butt timber onto the receiving timber. Pass None to skip scribe relief entirely. |
butt_timber()
|
Returns:
| Type | Description |
|---|---|
Joint
|
Joint object containing the cut butt timber and uncut receiving timber. |
Raises:
| Type | Description |
|---|---|
AssertionError
|
If the timbers are parallel. |
Source code in kumiki/joints/workshop/butt/plain_butt_joint.py
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 | |
cut_plain_butt_joint_on_face_aligned_timbers
¶
cut_plain_butt_joint_on_face_aligned_timbers(arrangement: ButtJointTimberArrangement) -> Joint
Creates a butt joint where the butt timber is cut flush with the face of the receiving timber.
Requires the timbers to be face-aligned. For an unrestricted version that works at any
angle, use cut_plain_butt_joint directly.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
arrangement
|
ButtJointTimberArrangement
|
Butt joint arrangement with butt_timber, receiving_timber, butt_timber_end. Timbers must be face-aligned and non-parallel. |
required |
Returns:
| Type | Description |
|---|---|
Joint
|
Joint object containing the cut butt timber and uncut receiving timber. |
Raises:
| Type | Description |
|---|---|
AssertionError
|
If the timbers are not face-aligned or are parallel. |
Source code in kumiki/joints/workshop/butt/plain_butt_joint.py
cut_tongue_and_fork_butt_joint_on_plane_aligned_timbers
¶
cut_tongue_and_fork_butt_joint_on_plane_aligned_timbers(arrangement: ButtJointTimberArrangement, tongue_thickness: Optional[Numeric] = None, tongue_position: Numeric = scalar(0), shoulder_inset: Numeric = scalar(0), relief: Union[None, ButtJointScribeReliefConfig] = butt_timber()) -> Joint
Creates a plain tongue-and-fork butt joint.
In this joint, the butt timber forms the fork (2 prongs with a central slot cut into it) and the receiving timber forms the tongue (material removed from both cheeks). The receiving (tongue) timber does not receive an end cut — it continues through the joint.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
arrangement
|
ButtJointTimberArrangement
|
Butt arrangement where butt_timber is the fork and receiving_timber is the tongue. |
required |
tongue_thickness
|
Optional[Numeric]
|
Tongue thickness along the shared plane normal. If None, defaults to 1/3 of the receiving timber dimension in that axis. |
None
|
tongue_position
|
Numeric
|
Offset of the tongue center from the receiving timber centerline along the shared plane normal. 0 means centered. |
scalar(0)
|
shoulder_inset
|
Numeric
|
Distance from the receiving timber entry face to the shoulder plane, measured perpendicular to the face inward. 0 = shoulder flush with the entry face. |
scalar(0)
|
relief
|
Union[None, ButtJointScribeReliefConfig]
|
Scribe-relief configuration for imperfect timbers. Defaults to scribing the fork (butt) timber onto the tongue (receiving) timber. Pass None to skip. |
butt_timber()
|
Returns:
| Type | Description |
|---|---|
Joint
|
Joint containing both cut timbers. |
Raises:
| Type | Description |
|---|---|
AssertionError
|
If timbers are not plane aligned, are parallel, or tongue parameters are out of bounds. |
Source code in kumiki/joints/workshop/butt/tongue_and_fork_butt_joint.py
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 | |
cut_dropin_dovetail_butt_joint_on_face_aligned_timbers
¶
cut_dropin_dovetail_butt_joint_on_face_aligned_timbers(arrangement: ButtJointTimberArrangement, receiving_timber_shoulder_inset: Numeric, dovetail_length: Numeric, dovetail_small_width: Numeric, dovetail_angle: Numeric, dovetail_lateral_offset: Numeric = scalar(0), dovetail_depth: Optional[Numeric] = None) -> Joint
Creates a dovetail butt joint (蟻継ぎ / Ari Tsugi) between two orthogonal timbers.
This is a traditional Japanese timber joint where a dovetail-shaped tenon on one timber fits into a matching dovetail socket on another timber. The dovetail shape provides mechanical resistance to pulling apart.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
arrangement
|
ButtJointTimberArrangement
|
Butt joint arrangement where butt_timber is the dovetail timber, receiving_timber receives the dovetail socket, butt_timber_end is the cut end, and front_face_on_butt_timber is the face where the dovetail profile is visible. |
required |
receiving_timber_shoulder_inset
|
Numeric
|
Distance to inset the shoulder notch on the receiving timber |
required |
dovetail_length
|
Numeric
|
Length of the dovetail tenon |
required |
dovetail_small_width
|
Numeric
|
Width of the narrow end of the dovetail (at the tip) |
required |
dovetail_angle
|
Numeric
|
Flare angle of the dovetail in radians (0 for straight dovetails) |
required |
dovetail_lateral_offset
|
Numeric
|
Lateral offset of the dovetail from center (default 0) |
scalar(0)
|
dovetail_depth
|
Optional[Numeric]
|
Depth of the dovetail cut. If None, defaults to half the timber dimension |
None
|
Returns:
| Type | Description |
|---|---|
Joint
|
Joint object containing the two CutTimbers with the dovetail cuts applied |
Raises:
| Type | Description |
|---|---|
ValueError
|
If the parameters are invalid or the timbers are not orthogonal |
Source code in kumiki/joints/workshop/butt/dropin_dovetail_butt_joint.py
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 | |
cut_dropin_housed_butt_joint_on_face_aligned_timbers
¶
cut_dropin_housed_butt_joint_on_face_aligned_timbers(arrangement: ButtJointTimberArrangement, receiving_timber_shoulder_inset: Numeric, housing_length: Numeric, housing_width: Numeric, housing_lateral_offset: Numeric = scalar(0), housing_depth: Optional[Numeric] = None) -> Joint
Creates a drop-in housed butt joint (housing slot pocket) between two orthogonal timbers.
Only the housing timber is cut to receive the square end of the housed timber. The housed timber drops into the pocket along the housing face normal.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
arrangement
|
ButtJointTimberArrangement
|
Butt joint arrangement where butt_timber is the housed timber, receiving_timber receives the housing pocket socket, butt_timber_end is the cut end, and front_face_on_butt_timber is the face where the pocket profile is open (normally the top face). |
required |
receiving_timber_shoulder_inset
|
Numeric
|
Distance to inset the shoulder notch on the receiving timber |
required |
housing_length
|
Numeric
|
Length of the housing slot pocket (the joist extension depth into the mudsill) |
required |
housing_width
|
Numeric
|
Width of the housing pocket |
required |
housing_lateral_offset
|
Numeric
|
Lateral offset of the housing pocket from center (default 0) |
scalar(0)
|
housing_depth
|
Optional[Numeric]
|
Depth of the pocket. If None, defaults to half the timber dimension |
None
|
Returns:
| Type | Description |
|---|---|
Joint
|
Joint object containing the two CutTimbers with the housing cuts applied |
Source code in kumiki/joints/workshop/butt/dropin_housed_butt_joint.py
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 | |
cut_wedged_half_dovetail_mortise_and_tenon_joint_on_face_aligned_timbers
¶
cut_wedged_half_dovetail_mortise_and_tenon_joint_on_face_aligned_timbers(arrangement: ButtJointTimberArrangement, tenon_size: V2, tenon_depth: Numeric, dovetail_depth: Numeric, wedge_accessory_parameters: DovetailTenonWedgeAccessoryParameters, tenon_lateral_offset: Numeric = scalar(0), receiving_timber_mortise_extra_depth: Numeric = scalar(0), mortise_shoulder_inset: Numeric = scalar(0), relief: Union[None, ButtJointScribeReliefConfig] = butt_timber()) -> Joint
Create a half-dovetail mortise-and-tenon joint (with an optional wedge accessory).
Built on top of dovetail_tenon_geometry. The "top" of the dovetail is flush with
arrangement.top_face_on_butt_timber; the opposite side slopes outward by dovetail_depth
over tenon_depth to give the joint its mechanical pull-out resistance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
arrangement
|
ButtJointTimberArrangement
|
Butt joint arrangement (butt_timber = tenon, receiving_timber = mortise). Must be face-aligned and orthogonal, with top_face_on_butt_timber set to the face the dovetail's flat "top" is flush with (the opposite face is the sloped side). |
required |
tenon_size
|
V2
|
Cross-section of the tenon (X = butt RIGHT axis, Y = butt TOP axis). |
required |
tenon_depth
|
Numeric
|
Depth of the tenon into the receiving timber, measured from the shoulder. |
required |
dovetail_depth
|
Numeric
|
How far the sloped side of the dovetail kicks out over |
required |
tenon_lateral_offset
|
Numeric
|
Offset of the tenon along the lateral direction (perpendicular to both length and top-to-bottom). 0 = centered on the butt timber. |
scalar(0)
|
receiving_timber_mortise_extra_depth
|
Numeric
|
Extra mortise depth in the receiving timber past the tenon tip. |
scalar(0)
|
mortise_shoulder_inset
|
Numeric
|
Distance from the mortise entry face to the shoulder plane, measured perpendicular to the entry face inward. 0 = shoulder flush with the entry face (the default). Positive pushes the shoulder deeper into the receiving timber. |
scalar(0)
|
wedge_accessory_parameters
|
DovetailTenonWedgeAccessoryParameters
|
If provided, a wedge accessory is added on the
|
required |
relief
|
Union[None, ButtJointScribeReliefConfig]
|
Scribe-relief configuration for imperfect timbers. Defaults to scribing the tenon (butt) timber onto the mortise (receiving) timber. Pass None to skip. |
butt_timber()
|
Returns:
| Type | Description |
|---|---|
Joint
|
Joint object with cuts on both timbers and (optionally) a "wedge" accessory. |
Source code in kumiki/joints/workshop/butt/wedged_half_dovetail_joint.py
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 | |
cut_splined_opposing_double_butt_joint_on_face_aligned_timbers
¶
cut_splined_opposing_double_butt_joint_on_face_aligned_timbers(arrangement: DoubleButtJointTimberArrangement, slot_thickness: Numeric, slot_depth: Numeric, spline_length: Numeric, slot_facing_end_on_receiving_timber: TimberEnd, spline_extra_depth=None, slot_symmetric_extra_length=mm(3), shoulder_symmetric_inset=scalar(0), slot_lateral_offset=scalar(0), peg_parameters: Optional[SimplePegParameters] = None) -> Joint
Creates a splined opposing double butt joint.
Two butt timbers approach the receiving timber from opposite cardinal directions. All three timbers must be face-aligned, each butt timber must be perpendicular to the receiving timber, and the two butt timbers must be antiparallel.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
arrangement
|
DoubleButtJointTimberArrangement
|
Double butt joint arrangement with butt_timber_1, butt_timber_2, receiving_timber, butt_timber_1_end, butt_timber_2_end. |
required |
Returns:
| Type | Description |
|---|---|
Joint
|
Joint containing all three cut timbers. |
Raises:
| Type | Description |
|---|---|
AssertionError
|
If the arrangement fails the cardinal-and-opposing-butts check. |
Source code in kumiki/joints/workshop/butt/splined_opposing_double_butt_joint.py
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 | |