- SolidPython: OpenSCAD for Python
- Advantages
- Installing SolidPython
- Using SolidPython
- Example Code
- Extra syntactic sugar
- solid.utils
- solid.screw_thread
- Jupyter Renderer
- Contact
- License
Table of Contents generated with DocToc
SolidPython is a generalization of Phillip Tiefenbacher's openscad module, found on Thingiverse. It generates valid OpenSCAD code from Python code with minimal overhead. Here's a simple example:
This Python code:
from solid import *
d = difference()(
cube(10),
sphere(15)
)
print(scad_render(d))
Generates this OpenSCAD code:
difference(){
cube(10);
sphere(15);
}
That doesn't seem like such a savings, but the following SolidPython code is a lot shorter (and I think clearer) than the SCAD code it compiles to:
from solid import * from solid.utils import * d = cube(5) + right(5)(sphere(5)) - cylinder(r=2, h=6)
Generates this OpenSCAD code:
difference(){
union(){
cube(5);
translate( [5, 0,0]){
sphere(5);
}
}
cylinder(r=2, h=6);
}
Because you're using Python, a lot of things are easy that would be hard or impossible in pure OpenSCAD. Among these are:
- built-in dictionary types
- mutable, slice-able list and string types
- recursion
- external libraries (images! 3D geometry! web-scraping! ...)
Install via PyPI:
pip install solidpython
(You may need to use
sudo pip install solidpython, depending on your environment. This is commonly discouraged though.)OR: Download SolidPython (Click here to download directly, or use git to pull it all down)
(Note that SolidPython also depends on the PyEuclid Vector math library, installable via
pip install euclid3)Unzip the file, probably in ~/Downloads/SolidPython-master
In a terminal, cd to location of file:
cd ~/Downloads/SolidPython-master
Run the install script:
python setup.py install
Include SolidPython at the top of your Python file:
from solid import * from solid.utils import * # Not required, but the utils module is useful
To include other scad code, call
use("/path/to/scadfile.scad")orinclude("/path/to/scadfile.scad"). This is identical to what you would do in OpenSCAD.OpenSCAD uses curly-brace blocks ({}) to create its tree. SolidPython uses parentheses with comma-delimited lists. OpenSCAD:
difference(){ cube(10); sphere(15); }SolidPython:
d = difference()( cube(10), # Note the comma between each element! sphere(15) )Call
scad_render(py_scad_obj)to generate SCAD code. This returns a string of valid OpenSCAD code.or: call
scad_render_to_file(py_scad_obj, filepath)to store that code in a file.If 'filepath' is open in the OpenSCAD IDE and Design => 'Automatic Reload and Compile' is checked (in the OpenSCAD IDE), calling
scad_render_to_file()from Python will load the object in the IDE.Alternately, you could call OpenSCAD's command line and render straight to STL.
The best way to learn how SolidPython works is to look at the included example code. If you've installed SolidPython, the following line of Python will print(the location of ) the examples directory:
import os, solid; print(os.path.dirname(solid.__file__) + '/examples')
Or browse the example code on Github here
Adding your own code to the example file solid/examples/solidpython_template.py will make some of the setup easier.
Following Elmo Mäntynen's suggestion, SCAD objects override the basic operators + (union), - (difference), and * (intersection). So
c = cylinder(r=10, h=5) + cylinder(r=2, h=30)
is the same as:
c = union()(
cylinder(r=10, h=5),
cylinder(r=2, h=30)
)
Likewise:
c = cylinder(r=10, h=5) c -= cylinder(r=2, h=30)
is the same as:
c = difference()(
cylinder(r=10, h=5),
cylinder(r=2, h=30)
)
OpenSCAD requires you to be very careful with the order in which you add
or subtract objects. SolidPython's hole() function makes this
process easier.
Consider making a joint where two pipes come together. In OpenSCAD you need to make two cylinders, union them, then make two smaller cylinders, union them, then subtract the smaller from the larger.
Using hole(), you can make a pipe, specify that its center should remain open, and then add two pipes together knowing that the central void area will stay empty no matter what other objects are added to that structure.
Example:
outer = cylinder(r=pipe_od, h=seg_length) inner = cylinder(r=pipe_id, h=seg_length) pipe_a = outer - hole()(inner)
Once you've made something a hole, eventually you'll want to put
something, like a bolt, into it. To do this, we need to specify that
there's a given 'part' with a hole and that other parts may occupy the
space in that hole. This is done with the part() function.
See solid/examples/hole_example.py for the complete picture.
OpenSCAD has a special variable, $t, that can be used to animate
motion. SolidPython can do this, too, using the special function
scad_render_animated_file().
See solid/examples/animation_example.py for more details.
SolidPython includes a number of useful functions in solid/utils.py. Currently these include:
up(10)(
cylinder()
)
seems a lot clearer to me than:
translate( [0,0,10])(
cylinder()
)
I've found this useful for fillets and rounds.
arc(rad=10, start_degrees=90, end_degrees=210)
draws an arc of radius 10 counterclockwise from 90 to 210 degrees.
arc_inverted(rad=10, start_degrees=0, end_degrees=90)
draws the portion of a 10x10 square NOT in a 90 degree circle of radius 10. This is the shape you need to add to make fillets or remove to make rounds.
To offset a set of points in one direction or another (inside or outside
a closed figure, for example) use
solid.utils.offset_points(point_arr, offset, inside=True)
Note that, for a non-convex figure, inside and outside may be
non-intuitive. The simple solution is to manually check that your offset
is going in the direction you intend, and change the boolean value of
inside if you're not happy.
See the code for futher explanation. Improvements on the inside/outside algorithm would be welcome.
solid.utils.extrude_along_path(shape_pts, path_pts, scale_factors=None)
See solid/examples/path_extrude_example.py for use.
You can change an object's color by using the OpenSCAD
color([rgba_array]) function:
transparent_blue = color([0,0,1, 0.5])(cube(10)) # Specify with RGB[A] red_obj = color(Red)(cube(10)) # Or use predefined colors
These colors are pre-defined in solid.utils:
| Red | Green | Blue |
| Cyan | Magenta | Yellow |
| Black | White | Transparent |
| Oak | Pine | Birch |
| Iron | Steel | Stainless |
| Aluminum | Brass | BlackPaint |
| FiberBoard |
They're a conversion of the materials in the MCAD OpenSCAD library, as seen [here] (https://github.com/openscad/MCAD/blob/master/materials.scad).
Put @bom_part() before any method that defines a part, then call
bill_of_materials() after the program is run, and all parts will be
counted, priced and reported.
The example file solid/examples/bom_scad.py illustrates this. Check it out.
solid.screw_thread includes a method, thread() that makes internal and external screw threads.
See solid/examples/screw_thread_example.py for more details.
Render SolidPython or OpenSCAD code in Jupyter notebooks using ViewSCAD, or install directly via:
pip install viewscad
(Take a look at the repo page, though, since there's a tiny bit more installation required)
Enjoy, and please send any questions or bug reports to me at
evan_t_jones@mac.com.
Cheers!
Evan
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
Some class docstrings are derived from the OpenSCAD User Manual, so are available under the Creative Commons Attribution-ShareAlike License.