Update readme and docs

This commit is contained in:
mmcwilliams 2020-08-27 02:27:25 -04:00
parent a8ab96ae37
commit 14b0c690b2
2 changed files with 10 additions and 6 deletions

View File

@ -1,6 +1,6 @@
# GNAL
Free and open source processing system for 16mm and Super8 film
A free and open-source processing system for 16mm and Super8 film
![GNAL 50ft V3 all pieces](/img/gnal_50ft_v3.jpg)
@ -155,11 +155,11 @@ Fused filament fabrication relies on the behavior of plastics at high heat to cr
The first thing to consider when your prints are coming out warped off the print bed is whether or not your **material** is appropriate for this model. Check the [#material](material) section of this README for more information, but theres a chance if you are using PLA or ABS that large flat prints of this size are warping due to limitations with the material you are using. PETG has proven to warp far less in my own anecdotal experience and is the recommended material for this project.
The thermal properties of the material you're printing are what leads to warping, so check if your printer is being set to the recommended **temperatures** on both the bed and extruder for the material you are using. Warping occurs consistently when a part cools too quickly and contracts while the rest of the part is still being printed. Avoid this by using an enclosure on your open-frame printer or by printing in a space with low air flow but still with appropriate ventilation for the material you use.
The thermal properties of the material you're printing are what causes warping, so check if your printer is being set to the recommended **temperatures** on both the bed and extruder for the material and printer you are using. Warping occurs consistently when a section of a part cools too quickly and contracts while the rest of it is still being printed. Avoid this by using an enclosure on your open-frame printer or by printing in a space with low air movement but still with appropriate ventilation for the material you use.
The **slicer** you use and the **settings** in its configuration will make a lot of difference in how your print comes out. During the development of this project [Cura](https://ultimaker.com/software/ultimaker-cura) is the slicer used most for test prints, however you might find that different software works best with your machine. The settings are important to test before you commit to a complete print of the spiral part.
Here is an example of the key settings used during development while printing with PETG.
Here is an example of the important settings used during development while printing with PETG.
|Setting|Value|
|---|---|
@ -169,7 +169,9 @@ Here is an example of the key settings used during development while printing wi
|Infill|20%|
|Print Speed|40 mm/s|
This is a fraction of the overall settings used by Cura, but they note some of the key features that were changed from the default profile for PETG and my printer.
This is a fraction of the overall settings that Cura has, but they note some of the key features that were changed from the default profile for PETG and my printer.
-----
To read more about developing and modifying the GNAL, check out the [development notes](docs/).

View File

@ -28,6 +28,7 @@ The `scripts/benchmark.sh` script will run various tests on the different approa
## Version notes
<a name="v1"></a>
### V1
Intended to be mostly compatible with existing processing spirals with some caveats. A spacer that is typically threaded has been replaced by a friction fit part so they are not interchangeable.
@ -67,9 +68,10 @@ Rendered using OpenSCAD version 2019.05 on a 2.2 GHz Core i7 (I7-4770HQ) chip ru
|gnal_100ft_spiral_top.stl|92423369|542836|223602.078125|89137|
|gnal_100ft_spiral_bottom.stl|N/A|N/A|N/A|N/A|
-----
<a name="v2"></a>
### V2
This version aims to improve printability over the V1 model and reducing render time of the spiral. The biggest change to the physical structure of the design is the removal of overhangs from beneath the spiral film guide.
@ -114,7 +116,7 @@ Rendered using OpenSCAD version 2020.01.17 on a 3.2 GHz Core i5 (I5-4460) chip r
The goals of V3 are to **greatly** optimize the spiral generation code for speed and to restore the feature of the V1 spiral which maintains a consistent size of individual facets throughout the spiral even as the diameter changes. This will be considered a stable release candidate for publishing the project.
Since the benchmarking process ([see below](#benchmarks)) was developed between V2 and V3, render times are optimized in this iteration of the project. The success of the `[scad/spiral/spiral_3.scad](spiral_3.scad)` approach stood out amongst the rest, so it was reworked into what exists in V3.
Since the benchmarking process ([see below](#benchmarks)) was developed between V2 and V3, render times are optimized in this iteration of the project. The success of the [`spiral_3.scad`](scad/spiral/spiral_3.scad) approach stood out from the rest as fastest, so it was reworked into what exists in V3.
The spiral itself is plotted in 2D with a relatively simple formula that is expressed in the OpenSCAD script through a number of in-line helper functions. It draws the position of various points along the spiral path and then uses the `path_extrude.scad` library to extrude a shape along those coordinates. This proves to be fast and efficient while not sacrificing any of the detail in the geometry.