Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

solidfunc

PyPI Python CI License: MIT

solidfunc is a typed, functional Python library for code-based CAD, built on SolidCore, a B-rep geometry kernel written in Rust. You build solids from primitives and planar profiles, place and combine them, select faces and edges, round and chamfer edges, and export STEP files for use in other CAD tools.

Install

pip install solidfunc

Wheels are available for Linux, macOS, and Windows on Python 3.11 and later.

A first part

A plate with a hole whose rim is rounded, exported as STEP:

import solidfunc as sf

plate = sf.box(size_x=80, size_y=50, size_z=10)
hole = sf.cylinder(diameter=20, height=10)
part = plate - hole

top = max(sf.faces(part), key=lambda face: face.centroid[2])
hole_edge = [edge for edge in sf.edges(top) if edge.kind == "circle"]
part = sf.fillet(part, hole_edge, radius=2.0)

print(f"{sf.volume(part):.3f} mm³")
sf.export_step(part, "plate.step")

Every operation returns a new value and leaves its inputs unchanged. Lengths are in millimetres and angles in degrees. Selection is plain Python over typed face and edge data. See the API reference for signatures and conventions.

Parts from the chapters of CAD as Code, rebuilt in solidfunc.

Clutch brick Battery tray
Clutch brick: studs placed on the top face with place() Battery tray: cell pockets, mirrored holes, and a lead-in round selected by radius
Swept elbow Round-to-rectangle duct
Swept elbow: a hollow section swept along a cornered path Duct: a loft from a circle to a rectangle

Viewing parts

Install PyVista with pip install pyvista, then call show():

from solidfunc.view import show

show(part)

Pass screenshot="part.png" to save a PNG. In Jupyter, show() displays a static preview by default. For an interactive view, install pyvista[jupyter] and pass jupyter_backend="client".

About this project

Motivation

The best-known open-source code-CAD libraries for Python, CadQuery and build123d, are built on the OpenCascade Technology (OCCT) kernel. SolidCore started as a Rust port of SMLib, the NURBS B-rep kernel that NVIDIA published as part of USD BRep, and has diverged from it since. solidfunc asks how much of a parametric code-CAD API depends on its kernel, and which of its ideas are properties of OCCT rather than of code-CAD in general.

Scope

solidfunc is a small academic experiment, not a replacement for CadQuery or build123d. For real work, use one of them. My book CAD as Code uses CadQuery's functional API throughout, and the first part above comes from chapter 2. solidfunc borrows many ideas from CadQuery and build123d.

Findings

  • SolidCore builds solids from geometric sketch records (segments, loops, regions), not from OCCT's topological edges and wires. solidfunc's Curve2D, Path2D, and Profile mirror those records, and topology (Face, Edge, Vertex) only exists inside a solid.
  • SolidCore stores a round on a straight edge as a cone with a zero half-angle, and revolve produces B-spline surfaces even for a cone or a sphere. solidfunc reports the first as a cylinder and documents the second, so selection by surface type depends on how the kernel stores surfaces.
  • SolidCore's booleans consume their operands, so solidfunc copies its inputs to keep every value unchanged.
  • SolidCore unites many bodies in one call, which became union(*shapes).

Coverage

solidfunc builds single solids from primitives, extrusions, revolutions, lofts, and sweeps, with booleans, placement, fillets and chamfers, face and edge queries, and STEP import and export. Assemblies, colours, open sheets and shells, and 2D operations on profiles are outside its scope. Releases are alphas, and the API can change between them.

Development

The repository includes a dev container in .devcontainer/ with the pinned Python and Rust toolchains, uv, and the OCP CAD Viewer extension. Opening the repository in it builds solidfunc and installs CadQuery for the STEP exchange tests.

To build from source without it, install uv and Rust, then run from the cloned repository:

uv sync --locked --config-setting build-args=--profile=dev
uv run --no-sync pytest
uv run --no-sync python examples/hello_world.py

examples/render_gallery.py regenerates the gallery images.

Citing

If you use solidfunc in your work, please cite it; GitHub's "Cite this repository" button gives the reference from CITATION.cff.

License

solidfunc is MIT licensed. SolidCore and the SMLib code it derives from (USD BRep) are Apache-2.0 licensed. The distribution includes the corresponding upstream notices. solidfunc is not affiliated with or endorsed by NVIDIA.

Metadata

Release files for solidfunc 0.1.0a4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for solidfunc 0.1.0a4
File Size Uploaded Provenance Actions
solidfunc-0.1.0a4.tar.gz 223.8 kB Without provenance Details for solidfunc-0.1.0a4.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for solidfunc 0.1.0a4
File Actions
solidfunc-0.1.0a4-cp311-abi3-win_amd64.whl CPython 3.11 abi3 Windows x86-64 Details for solidfunc-0.1.0a4-cp311-abi3-win_amd64.whl
solidfunc-0.1.0a4-cp311-abi3-manylinux_2_28_x86_64.whl CPython 3.11 abi3 Linux glibc 2.28+ x86-64 Details for solidfunc-0.1.0a4-cp311-abi3-manylinux_2_28_x86_64.whl
solidfunc-0.1.0a4-cp311-abi3-manylinux_2_28_aarch64.whl CPython 3.11 abi3 Linux glibc 2.28+ ARM64 Details for solidfunc-0.1.0a4-cp311-abi3-manylinux_2_28_aarch64.whl
solidfunc-0.1.0a4-cp311-abi3-macosx_11_0_arm64.whl CPython 3.11 abi3 macOS 11.0+ ARM64 Details for solidfunc-0.1.0a4-cp311-abi3-macosx_11_0_arm64.whl
solidfunc-0.1.0a4-cp311-abi3-macosx_10_12_x86_64.whl CPython 3.11 abi3 macOS 10.12+ x86-64 Details for solidfunc-0.1.0a4-cp311-abi3-macosx_10_12_x86_64.whl

Total release size: 83.8 MB

Release files / solidfunc-0.1.0a4.tar.gz

Download URL solidfunc-0.1.0a4.tar.gz
Size 223.8 kB
Tags Source
SHA-256 checksum
How to use checksums
60818f9a01b93904d4360b6435a98e9f87f6e89d14668322e4339f111b8dc748
BLAKE2b-256 checksum
How to use checksums
29015e2437c7973782bb14d14e61a76b56439e97f5f3098816538f35e39c9472
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.9 {"installer":{"name":"uv","version":"0.13.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / solidfunc-0.1.0a4-cp311-abi3-win_amd64.whl

Download URL solidfunc-0.1.0a4-cp311-abi3-win_amd64.whl
Size 16.7 MB
Tags CPython 3.11 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
53646c765ba8f8f33c10180802515dff9d74458fd6c64c5945e83686602185f0
BLAKE2b-256 checksum
How to use checksums
b63ad5d85c6f52e30075ceb36915c7f6d0f530fbd48755528882b63f45fc6ba5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.9 {"installer":{"name":"uv","version":"0.13.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / solidfunc-0.1.0a4-cp311-abi3-manylinux_2_28_x86_64.whl

Download URL solidfunc-0.1.0a4-cp311-abi3-manylinux_2_28_x86_64.whl
Size 17.7 MB
Tags CPython 3.11 Linux glibc 2.28+ x86-64 abi3
SHA-256 checksum
How to use checksums
89d32a8e9572fbc9b70c9d0c1183602faac0687a44da82de8ea3eb2c4377fb6a
BLAKE2b-256 checksum
How to use checksums
40d170c46a4faa2da024c9c7a40d425c4d7dcb368cb4a691355a6483f7596b43
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.9 {"installer":{"name":"uv","version":"0.13.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / solidfunc-0.1.0a4-cp311-abi3-manylinux_2_28_aarch64.whl

Download URL solidfunc-0.1.0a4-cp311-abi3-manylinux_2_28_aarch64.whl
Size 16.2 MB
Tags CPython 3.11 Linux glibc 2.28+ ARM64 abi3
SHA-256 checksum
How to use checksums
05752660198bd356cbfdd1de861392c95431975a24c61e4f952d7d37adff8462
BLAKE2b-256 checksum
How to use checksums
8390d1d7adbcd8b445516af93bc2af53a6d277e217c535a65cd1710904af0d73
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.9 {"installer":{"name":"uv","version":"0.13.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / solidfunc-0.1.0a4-cp311-abi3-macosx_11_0_arm64.whl

Download URL solidfunc-0.1.0a4-cp311-abi3-macosx_11_0_arm64.whl
Size 15.5 MB
Tags CPython 3.11 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
b883fe052f6393c3f28c3ebfdcb333e6837263554b09f0108c1e545d3677c04c
BLAKE2b-256 checksum
How to use checksums
c836209e394e9ce217b111f4ec7dc1ae30bcc8c70a77f24340c951a93c4ab2d2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.9 {"installer":{"name":"uv","version":"0.13.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / solidfunc-0.1.0a4-cp311-abi3-macosx_10_12_x86_64.whl

Download URL solidfunc-0.1.0a4-cp311-abi3-macosx_10_12_x86_64.whl
Size 17.5 MB
Tags CPython 3.11 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
0fea8bfded465816d8b67c366a806e5efc9b34c0ccfabea7857dcc063a83333d
BLAKE2b-256 checksum
How to use checksums
21a8eebfb98a187e35a9f037720045afb774f4ea9d5e9e1f12e5df2ceaa5f63a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.9 {"installer":{"name":"uv","version":"0.13.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for solidfunc 0.1.0a4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page