You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-9Lines changed: 15 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ This allows for rapid 3D printing of text, rendered equations, or simple digital
10
10
Use them for product prototyping, art, cookie cutters, ice cube trays, chocolate molds, (see [this](http://www.makerbot.com/tutorials/making-chocolate-molds/)
11
11
to learn how to make a printed object food-safe) or whatever else you can think of.
12
12
13
-
Some modification may be needed to the STL or printer settings to get certain shapes to print cleanly (ie. thicker base,
13
+
Some modification may be needed to the STL or printer settings to get certain shapes to print cleanly (i.e. thicker base,
14
14
support structures, etc).
15
15
16
16
Besides printing, these can also be merged into other 3D meshes for many other
@@ -30,16 +30,22 @@ want to write Python code directly.
30
30
-[Matplotlib](http://matplotlib.org/) 1.2.1 or higher (for rendering text and LaTeX to image data)
31
31
32
32
## Installation:
33
+
There are two ways to install `stl_tools`.
33
34
34
-
Run `python setup.py build install` to install.
35
+
It's recommended that you install Numpy, Scipy, and Matplotlib first, either
36
+
using binary installers (windows) or using a package manager (`apt-get`,
37
+
`homebrew`), etc.
38
+
39
+
### Installing straight from `PyPI`:
40
+
Run `pip install stl_tools`.
35
41
36
-
This will check for the 3rd party
37
-
dependencies above and install the library.
42
+
### Installing from Source:
43
+
Run `python setup.py build install` to install.
38
44
39
-
This will also install the
45
+
Either method will also install the
40
46
command line script `image2stl` into the `Python/Scripts` directory.
41
47
42
-
Automatic tests can be perfomed by running `stl_tools/test/test_stl.py`.
48
+
Automatic tests can be performed by running `stl_tools/test/test_stl.py`.
43
49
44
50
## Quickstart Examples:
45
51
@@ -175,10 +181,10 @@ There are 3 principal functions (no classes) to import and use from stl_tools:
175
181
It takes a 2D numpy array and output filename
176
182
as input, and writes an STL file.
177
183
178
-
Each element of the array is tesselated to its neighbors to produce 2 triangular faces for
184
+
Each element of the array is tessellated to its neighbors to produce 2 triangular faces for
179
185
every 4 contiguous elements. The depth axis of any vertex is taken to be the value of the array corresponding to that point.
180
186
181
-
The `scale` argument scales the height of the resulting geometry. It's a similair effect to extruding or shrinking.
187
+
The `scale` argument scales the height of the resulting geometry. It's a similar effect to extruding or shrinking.
182
188
183
189
The `mask_val` argument allows you to set a threshold value for elements in the input array for exclusion in the STL file.
184
190
Array elements which are less than this value will not be included as vertices.
@@ -230,7 +236,7 @@ arguments. See the examples above for usage.
230
236
## Tips:
231
237
232
238
- Consider scaling down a digital image before generating an STL from its pixels.
233
-
For images of standard sizes for modern cameras, the resulting STL filesize can be pretty large.
239
+
For images of standard sizes for modern cameras, the resulting STL file size can be pretty large.
234
240
235
241
- Just like was shown in the examples, applying a simple filtering function to smooth
236
242
sharp edges results in an STL geometry that is likely to be more easily printable. Fine tuning in a
0 commit comments