:description: planex2d: fast, exact 2D geometry for Python, written in C++. Lines, arcs and circles, exact Boolean operations, constraint sketches, cleanup of imported drawings, and export to OpenCASCADE, netgen/NGSolve and gmsh. .. role:: px-plan .. role:: px-ex2d :px-plan:`plan`\ :px-ex2d:`ex2d`: fast, exact 2D geometry for Python ===================================================================== planex2d is a 2D geometry kernel for Python, written in C++. You draw outlines from lines, arcs, circles and splines, combine them with exact Boolean operations, dimension them with constraints, and clean up drawings imported from other tools. The resulting faces go to OpenCASCADE, netgen/NGSolve, gmsh and other tools for 3D modeling, meshing and simulation. .. raw:: html

A fully constrained planex2d sketch of four tapped holes on a pitch circle, with its constraint signs, over the front of a bearing housing projected into the sketch's plane

Installation ------------ .. code-block:: bash pip install planex2d The package is called ``planex2d`` on PyPI and ``planex`` in Python (``import planex as px``). Version 0.1 has no prebuilt wheels yet, so pip builds it from source. See :doc:`Installation ` for the two extra steps this needs and for the optional packages. A first sketch -------------- planex2d has two sketch types with the same drawing calls. A ``QuickSketch`` draws the geometry directly, and a ``Sketch`` also solves constraints (see `Sketching`_ below). The simplest way to draw is with the pen. ``Line`` draws along the current direction, ``Turn`` changes the direction, ``Arc`` continues with a tangent arc, and ``Close`` joins the outline to its start. ``Circle`` adds a hole. The result is an angle bracket with an inner fillet and two holes. .. literalinclude:: landing_turtle.py :language: python .. image:: _static/gallery/landing-turtle.svg :width: 36% :align: center :alt: The angle bracket drawn by the pen: two legs, an inner fillet of radius 10 and a hole in each leg Geometry can also be defined by its relations to other elements instead of computed coordinates. The next sketch draws two bosses as construction circles, joins them with two tangent lines, and closes the outline with arcs that lie on the bosses' circles. planex2d finds the tangent points. Slots, fillets, offsets, patterns and the other profile tools work the same way. .. literalinclude:: landing_example.py :language: python .. image:: _static/gallery/landing-example.svg :width: 69% :align: center :alt: The link drawn by the sketch: two bosses joined by tangent lines and arcs, with a hole in each The :doc:`API conventions ` describe the few rules the whole Python API follows. Speed ----- planex2d does only 2D geometry, embedded in 3D where needed, and is built for speed. In our benchmarks it is faster than general-purpose OpenCASCADE and several polygon libraries on most of the tested tasks, while keeping arcs and circles exact. See the :doc:`benchmark results ` for the tests, the method and the timings. .. raw:: html

Bar chart comparing the time planex2d, shapely, the fastest of pyclipper, gdstk and manifold3d, and OpenCASCADE need for the same five tasks

Unions: planex2d vs polygon libraries vs OpenCASCADE

How planex2d works ------------------ **Faces that touch share their edges exactly.** planex2d splits edges where they cross or overlap, keeps the pieces that belong to the result and joins them into its boundary. Each vertex is computed once and shared bit-exactly by the edges that meet there, so neighboring faces meet without gaps. The figure shows the same approach for an offset: each edge is offset on its own, the offset edges are cut where they cross, and the pieces that belong to the result form the new face. .. image:: _static/landing/how-offset.svg :width: 100% :alt: A wire of two lines, each line offset on its own, the edges cut where they cross with the pieces inside the other loop marked, and the resulting face **Holes do not depend on drawing direction.** Whether a loop is material or a hole follows from how deep it is nested. A loop inside an odd number of other loops is a hole, and a loop inside an even number is material, however it was drawn. .. image:: _static/landing/how-nesting.svg :width: 100% :alt: Four nested loops drawn in different directions and numbered by nesting depth, and the two faces made of them **Imported drawings can be cleaned up.** Drawings from DXF files and other tools often have tiny gaps and very short edges, which get in the way of Boolean operations and meshing. ``CloseGaps`` snaps endpoints to nearby endpoints within a tolerance you give, and ``RemoveSmallEdges`` removes edges shorter than a given length and merges their ends. See :doc:`Small gaps ` and :doc:`Small edges ` for details. .. image:: _static/landing/how-cleanup.svg :width: 100% :alt: An outline with a tiny gap and a tiny edge at an odd angle, both magnified, and the cleaned face with snapped endpoints and one vertex instead of the tiny edge **Tessellated outlines can become curves again.** Outlines made of many short edges can be simplified. planex2d fits arcs to chains that are nearly circular and replaces runs of short edges along a smooth curve with one spline, within a tolerance you give. See :doc:`Defeaturing ` for details. .. image:: _static/landing/how-fitting.svg :width: 100% :alt: A triangle-like outline whose top corner is a tessellated arc and whose bottom is a tessellated sine curve, magnified, and the same outline after fitting: two lines, one arc and one spline Sketching --------- A ``Sketch`` adds a constraint solver to the same drawing calls. You add geometric constraints and dimensions, and the solver keeps them satisfied after every change. This is what makes parametric design possible: change a dimension later, and the drawing follows. See the guides to :doc:`quick sketches ` and :doc:`constraint sketches `. In the example below, three lines are drawn roughly between two fixed circles. The constraints make each line tangent to both circles, with its ends on them. The solver starts from the rough drawing, so each line keeps the side and direction it was drawn with. .. code-block:: python sk = px.Sketch() sk.Circle(0, 0, 1.0, px.Fix, id="left") sk.Circle(4, 0.5, 0.6, px.Fix, id="right") sk.Move((-0.3, 1.4)).Line((4.2, 1.3), id="upper") sk.Move((0.2, -1.3)).Line((4.1, -0.3), id="lower") sk.Move((0.1, 1.2)).Line((3.6, -0.2), id="cross") for line in ("upper", "lower", "cross"): sk.Constrain(line, "left", px.Tangent) sk.Constrain(line, "right", px.Tangent) sk.Constrain(line + ".start", "left", px.Coincident) sk.Constrain(line + ".end", "right", px.Coincident) .. image:: _static/landing/how-tangent.svg :width: 100% :alt: Two circles and three lines drawn roughly, and the same lines made tangent to both circles with their ends on them, each keeping its side A constraint sketch can describe a complete part. The tilt bracket (a) has bosses, tangent edges, R6 fillets and a curved slot centered on the pivot. The T-slot profile (b) dimensions one eighth of the section and builds the rest by symmetry. Green means the sketch is fully constrained. Named dimensions, such as the length of ``AB``, can be changed later, and the sketch updates. .. raw:: html

(a) Tilt bracket

(b) T-slot extrusion profile

**Parameter sweeps.** Because a constraint sketch can be updated, one parametric sketch can produce a whole family of designs. The meander inverted-F antenna below is one sketch: a linear pattern repeats the meander, and the depth, pitch, feed offset and number of meanders are dimensions. Each design is one call to ``Update`` on the same sketch, here the one for design (b). The copper is the center line offset by half the trace width. .. code-block:: python antenna.Update({"meanders.count": 4, "depth": 5, "pitch": 2, "feed offset": 2}) .. image:: _static/landing/how-sweep.svg :width: 100% :alt: A meander inverted-F antenna in gold on a dark green board in three designs with three, four and five meanders Optimization ------------ planex2d works with numerical optimizers. In the :doc:`3D cold plate example `, SciPy's COBYLA optimizer moves four points of a constrained pipe sketch. Each candidate layout is meshed by netgen and solved in NGSolve for the oil flow and the plate temperature in 3D. The optimizer lowers the hottest temperature while keeping the pressure drop within a limit. .. code-block:: python from scipy.optimize import minimize result = minimize(pnorm, x0, method="COBYLA", constraints=limits) Here ``pnorm`` builds and solves one layout and returns a smooth measure of the hottest temperature, and ``limits`` keep the pipe's bends, clearances and pressure drop within bounds. The figures compare the straight pipe the optimizer starts from, the best layout it found, and that layout in 3D. .. raw:: html

The temperature at the bottom of a cold plate cooled by a straight pipe

(a) Initial straight pipe

The temperature at the bottom of the cold plate after SciPy's COBYLA optimized the pipe's path

(b) Optimized pipe layout

The optimized cold plate in 3D: the plate and the pipe along the optimized path

Using the solver directly ------------------------- The constraint solver is not limited to drawings. It can solve mechanisms and other geometric systems whose positions follow from dimensions and relations. One sketch models Jansen's walking leg, with the crank angle updated for each frame (a). Another sweeps the cylinder lengths of an excavator arm to find the reach of its tooth (b). The same arm also solves the other way round: give the tooth's position and the bucket angle, and the solver returns the cylinder lengths (c). This shows where the tooth can reach a level floor and where the cylinders' stroke limits make a position impossible. See the :doc:`excavator arm example ` for the complete model. .. raw:: html

(a) Jansen's leg: one sketch, the crank angle updated

The three cylinder lengths that keep the tooth on a level floor, against its distance from the swing axis

The working range of an excavator's tooth, with the arm in three positions

(b) Reach of an excavator's tooth

Integrations: import and export ------------------------------- planex2d passes faces to OpenCASCADE, netgen/NGSolve and gmsh, and reads geometry from KiCad, DXF and shapely. The examples show a tilt bracket extruded and analyzed in NGSolve (a), a face meshed with quadrilaterals by gmsh (b), and a KiCad board read with its copper and drill holes (c). The board is the `pic_programmer `_ demo from the KiCad project. Its image is reproduced under the same `CC BY-SA 4.0 license `_. .. image:: _static/landing/how-integrations.png :width: 100% :alt: The tilt bracket solved in NGSolve, its face meshed by gmsh with quadrilaterals, and a KiCad board read in 3D Examples -------- .. raw:: html

Toy planeA toy airliner built from sketches, with its fuselage, wings and engines lofted through sections.

Surface magnet motorA lamination glued into regions, its field, and a 12-slot design under load.

Excavator armA 20-tonne excavator modeled as a constraint sketch, with 6,615 solved positions used to calculate the tooth's reach.

A slicer for 3D printingA STEP part sliced into layers, each converted into perimeters and infill.

Spur gears under loadInvolute gears constructed tooth by tooth, meshed and loaded to calculate stress at the contact.

Voronoi boneThousands of struts combined into a scaffold for stiffness analysis and comparison with a scaling law.

See the :doc:`full example collection `, from mechanisms and antennas to meshing and simulation. Each example is checked against a formula or a measured property. License ------- planex2d is free software under the GNU Lesser General Public License, version 2.1 or later. It includes code from Eigen, pybind11 and Taskflow, uses the Netgen library, and makes use of facilities provided by Open CASCADE Technology. See :doc:`License and notices ` for the licenses and notices. .. toctree:: :maxdepth: 2 :hidden: :caption: About core/installation core/conventions core/testing core/building core/ai core/notices core/roadmap .. toctree:: :maxdepth: 2 :hidden: :caption: Core core/basics/index core/plotting/index core/sketch/index core/constraints/index core/booleans/index core/measuring/index core/files core/defeaturing/index core/comparison/index .. toctree:: :maxdepth: 2 :hidden: :caption: Integrations integrations/occ/index integrations/netgen/index integrations/fenicsx integrations/shapely integrations/scipy integrations/pytorch integrations/kicad integrations/numpy .. toctree:: :maxdepth: 2 :hidden: :caption: Examples examples/index .. toctree:: :maxdepth: 2 :hidden: :caption: Experimental experimental/deformable/index .. toctree:: :maxdepth: 2 :hidden: :caption: API api/index