build123d logo

What is build123d?

build123d is a Python library for 2D and 3D CAD. A model is a Python program: shapes are made, placed and combined in code, dimensions are variables, and changing one and running the program again gives the new part. It is built on the Open Cascade geometric kernel, the boundary representation (BREP) kernel behind FreeCAD, so its models are exact geometry, suitable for 3D printing, CNC machining and laser cutting, and can be exported as STEP to FreeCAD, SolidWorks and other CAD systems.

This tea cup is about forty lines of Python. See how it is made, in both of the styles build123d can be written in.

Where to start

This documentation is organized on the Diátaxis framework, which sorts documentation by what the reader needs at the time: tutorials for learning, how-to guides for getting a task done, reference for looking something up, and explanation for understanding.

  • New to build123d? Getting Started covers installation, a first model, and the two modes a model can be written in.

  • Learning it? The Tutorials each build a complete part, step by step.

  • Working on a design? The How-to Guides are organized by task, and the Cheat Sheet lists everything on one page.

  • Deciding whether to use it, or wondering why it works the way it does? Start with Why build123d.

  • Looking for ideas? The Examples are finished models with their code.

  • Want to test what you have learned? The Challenges each give a drawing of a part to model, and the mass your result should come to.

Note

This documentation is available in pdf and epub formats for reference while offline.

Note

There is a Discord server (shared with CadQuery) where you can ask for help in the build123d channel.

Table Of Contents