Python: module skeinforge_application.skeinforge

skeinforge_application.skeinforge ($Date: 2008/02/05 $) | index /home/enrique/Desktop/backup/babbleold/script/reprap/fabmetheus/skeinforge_application/skeinforge.py

Previous / Next / Contents

`
Overview
Introduction
Command Line Interface
Contribute
Documentation
Fabrication
File Formats
Getting Skeinforge
Getting Started
License
Motto
Troubleshooting
Examples
`

## Overview

### Introduction

Skeinforge is a GPL tool chain to forge a gcode skein for a model.
The tool chain starts with carve, which carves the model into layers, then the layers are modified by other tools in turn like fill, comb, tower, raft, stretch, hop, wipe, fillet & export. Each tool automatically gets the gcode from the previous tool. So if you want a carved & filled gcode, call the fill tool and it will call carve, then it will fill and output the gcode. If you want to use all the tools, call export and it will call in turn all the other tools down the chain to produce the gcode file.
If you do not want a tool after preface to modify the output, deselect the Activate checkbox for that tool. When the Activate checkbox is off, the tool will just hand off the gcode to the next tool without modifying it.
The skeinforge module provides a single place to call up all the setting dialogs. When the 'Skeinforge' button is clicked, skeinforge calls export, since that is the end of the chain.
The plugin buttons which are commonly used are bolded and the ones which are rarely used have normal font weight.
There are also tools which handle settings for the chain, like polyfile.
The analyze tool calls plugins in the analyze_plugins folder, which will analyze the gcode in some way when it is generated if their Activate checkbox is selected.
The interpret tool accesses and displays the import plugins.
The default settings are similar to those on Nophead's machine. A setting which is often different is the 'Layer Height' in carve.

### Command Line Interface

To bring up the skeinforge dialog without a file name, type:
python skeinforge_application/skeinforge.py
Slicing a file from skeinforge_utilities/skeinforge_craft.py, for example:
python skeinforge_application/skeinforge_utilities/skeinforge_craft.py test.stl
will slice the file and exit. This is the correct option for programs which use skeinforge to only generate a gcode file.
Slicing a file from skeinforge.py, for example:
python skeinforge_application/skeinforge.py test.stl
will slice the file and bring up the skeinforge window and the analyze windows and then skeinforge will wait for user input.
Slicing a file from skeinforge_plugins/craft.py, for example:
python skeinforge_application/skeinforge_plugins/craft.py test.stl
will slice the file and bring up the analyze windows only and then skeinforge will wait for user input.

### Contribute

You can contribute by helping develop the manual at:
http://fabmetheus.crsndoo.com/wiki/index.php/Skeinforge
There is also a forum thread about how to contribute to skeinforge development at:
http://dev.forums.reprap.org/read.php?12,27562
I will only reply to emails from contributors or to complete bug reports.

### Documentation

There is a manual at:
http://fabmetheus.crsndoo.com/wiki/index.php/Skeinforge
There is also documentation is in the documentation folder, in the doc strings for each module and it can be called from the '?' button or the menu or by clicking F1 in each setting dialog.
A list of other tutorials is at:
http://fabmetheus.crsndoo.com/wiki/index.php/Skeinforge#Tutorials
Skeinforge tagged pages on thingiverse can be searched for at:
http://www.thingiverse.com/search?cx=015525747728168968820%3Arqnsgx1xxcw&cof=FORID%3A9&ie=UTF-8&q=skeinforge&sa=Search&siteurl=www.thingiverse.com%2F#944

### Fabrication

To fabricate a model with gcode and the Arduino you can use the send.py in the fabricate folder. The documentation for it is in the folder as send.html and at:
http://reprap.org/bin/view/Main/ArduinoSend
Another way is to use an EMC2 or similar computer controlled milling machine, as described in the "ECM2 based repstrap" forum thread at:
http://forums.reprap.org/read.php?1,12143
using the M-Apps package, which is at:
http://forums.reprap.org/file.php?1,file=772
Another way is to use Zach's ReplicatorG at:
http://replicat.org/
There is also an older Processing script at:
http://reprap.svn.sourceforge.net/viewvc/reprap/trunk/users/hoeken/arduino/GCode_Host/
Yet another way is to use the reprap host, written in Java, to load and print gcode:
http://dev.www.reprap.org/bin/view/Main/DriverSoftware#Load_GCode
For jogging, the Metalab group wrote their own exerciser, also in Processing:
http://reprap.svn.sourceforge.net/viewvc/reprap/trunk/users/metalab/processing/GCode_Exerciser/
The Metalab group has descriptions of skeinforge in action and their adventures are described at:
http://reprap.soup.io/
There is a board about printing issues at:
http://www.bitsfrombytes.com/fora/user/index.php?board=5.0
You can buy the Rapman (an improved Darwin) from Bits from Bytes at:
http://www.bitsfrombytes.com/
You can buy the Makerbot from Makerbot Industries at:
http://www.makerbot.com/

### File Formats

An explanation of the gcodes is at:
http://reprap.org/bin/view/Main/Arduino_GCode_Interpreter
and at:
http://reprap.org/bin/view/Main/MCodeReference
A gode example is at:
http://forums.reprap.org/file.php?12,file=565
The settings are saved as tab separated .csv files in the .skeinforge folder in your home directory. The settings can be set in the tool dialogs. The .csv files can also be edited with a text editor or a spreadsheet program set to separate tabs.
The Scalable Vector Graphics file produced by vectorwrite can be opened by an SVG viewer or an SVG capable browser like Mozilla:
http://www.mozilla.com/firefox/
A good triangle surface format is the GNU Triangulated Surface format, which is supported by Mesh Viewer and described at:
http://gts.sourceforge.net/reference/gts-surfaces.html#GTS-SURFACE-WRITE
You can export GTS files from Art of Illusion with the Export GNU Triangulated Surface.bsh script in the Art of Illusion Scripts folder.
STL is an inferior triangle surface format, described at:
http://en.wikipedia.org/wiki/STL_(file_format)
If you're using an STL file and you can't even carve it, try converting it to a GNU Triangulated Surface file in Art of Illusion. If it still doesn't carve, then follow the advice in the troubleshooting section.

### Getting Skeinforge

The latest version is at:
http://members.axion.net/~enrique/reprap_python_beanshell.zip
a sometimes out of date version is in the last reprap_python_beanshell.zip attachment in the last post of the Fabmetheus blog at:
http://fabmetheus.blogspot.com/
another sometimes out of date version is at:
https://reprap.svn.sourceforge.net/svnroot/reprap/trunk/reprap/miscellaneous/python-beanshell-scripts/

### Getting Started

For skeinforge to run, install python 2.x on your machine, which is available from:
http://www.python.org/download/
To use the settings dialog you'll also need Tkinter, which probably came with the python installation. If it did not, look for it at:
http://www.tcl.tk/software/tcltk/
If you want python and Tkinter together on MacOS, you can try:
http://www.astro.washington.edu/users/rowen/ROPackage/Overview.html
If you want python and Tkinter together on all platforms and don't mind filling out forms, you can try the ActivePython package from Active State at:
http://www.activestate.com/Products/activepython/feature_list.mhtml
The computation intensive python modules will use psyco if it is available and run about twice as fast. Psyco is described at:
http://psyco.sourceforge.net/index.html
The psyco download page is:
http://psyco.sourceforge.net/download.html
Skeinforge imports Stereolithography (.stl) files or GNU Triangulated Surface (.gts) files. If importing an STL file directly doesn't work, an indirect way to import an STL file is by turning it into a GTS file is by using the Export GNU Triangulated Surface script at:
http://members.axion.net/~enrique/Export%20GNU%20Triangulated%20Surface.bsh
The Export GNU Triangulated Surface script is also in the Art of Illusion folder, which is in the same folder as skeinforge.py. To bring the script into Art of Illusion, drop it into the folder ArtOfIllusion/Scripts/Tools/. Then import the STL file using the STL import plugin in the import submenu of the Art of Illusion file menu. Then from the Scripts submenu in the Tools menu, choose 'Export GNU Triangulated Surface' and select the imported STL shape. Click the 'Export Selected' checkbox and click OK. Once you've created the GTS file, you can turn it into gcode by typing in a shell in the same folder as skeinforge:
> python skeinforge.py
When the skeinforge dialog pops up, click 'Skeinforge', choose the file which you exported in 'Export GNU Triangulated Surface' and the gcode file will be saved with the suffix '_export.gcode'.
Or you can turn files into gcode by adding the file name, for example:
> python skeinforge.py Screw Holder Bottom.stl

### License

GNU Affero General Public License
http://www.gnu.org/licenses/agpl.html

### Motto

I may be slow, but I get there in the end.

### Troubleshooting

If there's a bug, try downloading the very latest version because skeinforge is often updated without an announcement. The very latest version is at:
http://members.axion.net/~enrique/reprap_python_beanshell.zip
If there is still a bug, then first prepare the following files:
1. stl file
2. pictures explaining the problem
3. your settings (pack the whole .skeinforge directory with all your settings)
4. alterations folder, if you have any active alterations files
Then zip all the files.
Second, write a description of the error, send the description and the archive to the developer, enrique ( perez_enrique AT yahoo.com.removethispart ). After a bug fix is released, test the new version and report the results to enrique, whether the fix was successful or not.
If the dialog window is too big for the screen, on most Linux window managers you can move a window by holding down the Alt key and then drag the window with the left mouse button to get to the off screen widgets.
If you can't use the graphical interface, you can change the settings for skeinforge by using a text editor or spreadsheet to change the settings in the profiles folder in the .skeinforge folder in your home directory.
Comments and suggestions are welcome, however, I won't reply unless you are a contributor. Likewise, I will only answer your questions if you contribute to skeinforge in some way. Some ways of contributing to skeinforge are in the contributions thread at:
http://dev.forums.reprap.org/read.php?12,27562
You could also contribute articles to demozendium on any topic:
http://fabmetheus.crsndoo.com/wiki/index.php/Main_Page
If you contribute in a significant way to another open source project, I will consider that also.
When I answered everyone's questions, eventually I received more questions than I had time to answer, so now I only answer questions from contributors.
I reserve the right to make any correspondence public. Do not send me any correspondence marked confidential. If you do I will delete it.

## Examples

The following examples forge the STL file Screw Holder.stl. The examples are run in a terminal in the folder which contains Screw Holder.gts and skeinforge.py.
> python skeinforge.py
This brings up the dialog, after clicking 'Skeinforge', the following is printed:
The exported file is saved as Screw Holder_export.gcode
> python skeinforge.py Screw Holder.stl
The exported file is saved as Screw Holder_export.gcode
To run only fill for example, type in the craft_plugins folder which fill is in:
> python fill.py

Previous / Next / Contents

Modules
`` |  |
__init__ fabmetheus_utilities.archive fabmetheus_utilities.euclidean | fabmetheus_utilities.fabmetheus_tools.fabmetheus_interpret fabmetheus_utilities.gcodec os | fabmetheus_utilities.settings skeinforge_application.skeinforge_utilities.skeinforge_craft skeinforge_application.skeinforge_utilities.skeinforge_polyfile | skeinforge_application.skeinforge_utilities.skeinforge_profile sys

Classes
`` |  | SkeinforgeRepository
class SkeinforgeRepository
`` | `A class to handle the skeinforge settings.`
| Methods defined here: __init__(self) `Set the default settings, execute title & settings fileName.` execute(self) `Skeinforge button has been clicked.` save(self) `Profile has been saved and profile menu should be updated.`

Functions
`` |  | addToProfileMenu(profileSelection, profileType, repository) `Add a profile menu.` getNewRepository() `Get new repository.` getPluginFileNames() `Get skeinforge plugin fileNames.` getRadioPluginsAddPluginGroupFrame(directoryPath, importantFileNames, names, repository) `Get the radio plugins and add the plugin frame.` main() `Display the skeinforge dialog.` writeOutput(fileName) `Craft a file, display dialog.`

Data
`` |  | __author__ = 'Enrique Perez (perez_enrique@yahoo.com)' __credits__ = '\nAdrian Bowyer <http://forums.reprap.org/profile...:\nArt of Illusion <http://www.artofillusion.org/>' __date__ = '$Date: 2008/02/05 $' __license__ = 'GNU Affero General Public License http://www.gnu.org/licenses/agpl.html' absolute_import = _Feature((2, 5, 0, 'alpha', 1), (2, 7, 0, 'alpha', 0), 16384)

Author
`` |  | Enrique Perez (perez_enrique@yahoo.com)

Credits
`` |  | Adrian Bowyer <http://forums.reprap.org/profile.php?12,13> Brendan Erwin <http://forums.reprap.org/profile.php?12,217> Greenarrow <http://forums.reprap.org/profile.php?12,81> Ian England <http://forums.reprap.org/profile.php?12,192> John Gilmore <http://forums.reprap.org/profile.php?12,364> Jonwise <http://forums.reprap.org/profile.php?12,716> Kyle Corbitt <http://forums.reprap.org/profile.php?12,90> Michael Duffin <http://forums.reprap.org/profile.php?12,930> Marius Kintel <http://reprap.soup.io/> Nophead <http://www.blogger.com/profile/12801535866788103677> PJR <http://forums.reprap.org/profile.php?12,757> Reece.Arnott <http://forums.reprap.org/profile.php?12,152> Wade <http://forums.reprap.org/profile.php?12,489> Xsainnz <http://forums.reprap.org/profile.php?12,563> Zach Hoeken <http://blog.zachhoeken.com/> Organizations: Art of Illusion <http://www.artofillusion.org/>