Extra python modules/de

Auf dieser Seite findet man einige zusätzliche Python Module oder andere Software, die kostenlos aus dem Internet heruntergeladen werden können und die FreeCAD-Installation um Funktionen zu erweitern.

PySide (vorher PyQt4)

 * Homepage (PySide): (http://qt-project.org/wiki/PySide http://qt-project.org/wiki/PySide http://qt-project.org/wiki/PySide)
 * Lizenz: LGPL
 * optional, wird aber von mehreren Modulen benötigt: Entwurf, Bogen, Schiff, Druck, OpenSCAD, Kalkulationsblatt

PySide (früher PyQt) wird von mehreren Modulen von FreeCAD benötigt, um auf die Qt-Schnittstelle von FreeCAD zuzugreifen. Es ist bereits in der Windows-Version von FreeCAD enthalten und wird in der Regel automatisch von FreeCAD unter Linux installiert, wenn es aus offiziellen Repositories installiert wird. Wenn diese Module (Draft, Arch, etc.) nach der Installation von FreeCAD aktiviert werden, bedeutet das, dass PySide (früher PyQt) bereits vorhanden ist und nichts mehr getan werden muss.

Hinweis: FreeCAD hat sich nach und nach von PyQt ab Version 0.13 zu Gunsten von PySide entfernt, das genau den gleichen Job macht, aber eine (LGPL) Lizenz hat, die besser mit FreeCAD kompatibel ist.

Linux
Der einfachste Weg, PySide zu installieren, ist über den Paketmanager Ihrer Distribution. Auf Debian/Ubuntu-Systemen lautet der Paketname im Allgemeinen python-PySide, während er auf RPM-basierten Systemen pyside genannt wird. Die notwendigen Abhängigkeiten (Qt und SIP) werden automatisch erledigt.

Windows
Das Programm kann unter http://qt-project.org/wiki/Category:LanguageBindings::PySide::Downloads heruntergeladen werden. Du must die Qt- und SIP-Bibliotheken installieren, bevor Du PySide installieren kannst (zu dokumentieren).

MacOSX
PyQt auf Mac kann über Homebrew oder Port installiert werden. Weitere Informationen findet man unter Install dependencies.

Verwendung
Sobald es installiert ist, kann überprüft werden, ob alles funktioniert, indem in die FreeCAD Python-Konsole eingegeben wird:

Um auf die FreeCAD-Schnittstelle zuzugreifen, gib ein :

Nun kann mit dem Befehl dir begonnen werden, die Oberfläche zu erkunden. Neue Elemente können ergänzt werden, wie ein benutzerdefiniertes Widget, mit Befehlen wie :

Arbeiten mit Unicode :

Arbeiten mit QFileDialog und OpenFileName :

Arbeiten mit QFileDialog und SaveFileName :

Beispiel für den Übergang von PyQt4 und PySide
PS: diese Beispiele von Fehlern wurden beim Übergang von PyQt4 zu PySide gefunden und diese Korrekturen wurden vorgenommen, andere Lösungen sind sicherlich mit den obigen Beispielen verfügbar

Um auf die FreeCAD Oberfläche zuzugreifen, gib ein : Du kannst neue Elemente hinzufügen, wie ein benutzerdefiniertes Widget, mit Befehlen wie :

Arbeiten mit Unicode :

Arbeiten mit QFileDialog und OpenFileName :

Arbeiten mit QFileDialog und SaveFileName :

Die MitteilungsBox:

Arbeiten mit setProperty (PyQt4) und setValue (PySide)

ersetzen durch :

Arbeiten mit setToolTip

ersetzen durch :

oder:

Additional documentation
Some pyQt4 tutorials (including how to build interfaces with Qt Designer to use with python):
 * http://pyqt.sourceforge.net/Docs/PyQt4/classes.html - the PyQt4 API Reference on sourceforge
 * http://www.rkblog.rk.edu.pl/w/p/introduction-pyqt4/ - a simple introduction
 * http://www.zetcode.com/tutorials/pyqt4/ - very complete in-depth tutorial

Pivy

 * homepage: https://bitbucket.org/Coin3D/coin/wiki/Home
 * license: BSD
 * optional, but needed by several modules of FreeCAD: Draft, Arch

Pivy is a needed by several modules to access the 3D view of FreeCAD. On windows, Pivy is already bundled inside the FreeCAD installer, and on Linux it is usually automatically installed when you install FreeCAD from an official repository. On MacOSX, unfortunately, you will need to compile pivy yourself.

Prerequisites
I believe before compiling Pivy you will want to have Coin and SoQt installed.

I found for building on Mac it was sufficient to install the Coin3 binary package. Attempting to install coin from MacPorts was problematic: tried to add a lot of X Windows packages and ultimately crashed with a script error.

For Fedora I found an RPM with Coin3.

SoQt compiled from source fine on Mac and Linux.

Debian & Ubuntu
Starting with Debian Squeeze and Ubuntu Lucid, pivy will be available directly from the official repositories, saving us a lot of hassle. In the meantime, you can either download one of the packages we made (for debian and ubuntu karmic) availables on the Download pages, or compile it yourself.

The best way to compile pivy easily is to grab the debian source package for pivy and make a package with debuild. It is the same source code from the official pivy site, but the debian people made several bug-fixing additions. It also compiles fine on ubuntu karmic: http://packages.debian.org/squeeze/python-pivy download the .orig.gz and the .diff.gz file, then unzip both, then apply the .diff to the source: go to the unzipped pivy source folder, and apply the .diff patch:

then

to have pivy properly built into an official installable package. Then, just install the package with gdebi.

Other linux distributions
First get the latest sources from the project's repository:

As of March 2012, the latest version is Pivy-0.5.

Then you need a tool called SWIG to generate the C++ code for the Python bindings. Pivy-0.5 reports that it has only been tested with SWIG 1.3.31, 1.3.33, 1.3.35, and 1.3.40. So you can download a source tarball for one of these old versions from http://www.swig.org. Then unpack it and from a command line do (as root):

It takes just a few seconds to build.

Alternatively, you can try building with a more recent SWIG. As of March 2012, a typical repository version is 2.0.4. Pivy has a minor compile problem with SWIG 2.0.4 on Mac OS (see below) but seems to build fine on Fedora Core 15.

After that go to the pivy sources and call

which creates the source files. Note that build can produce thousands of warnings, but hopefully there will be no errors.

This is probably obsolete, but you may run into a compiler error where a 'const char*' cannot be converted in a 'char*'. To fix that you just need to write a 'const' before in the appropriate lines. There are six lines to fix.

After that, install by issuing (as root):

That's it, pivy is installed.

Mac OS
These instructions may not be complete. Something close to this worked for OS 10.7 as of March 2012. I use MacPorts for repositories, but other options should also work.

As for linux, get the latest source:

If you don't have hg, you can get it from MacPorts:

Then, as above you need SWIG. It should be a matter of:

I found I needed also:

As of March 2012, MacPorts SWIG is version 2.0.4. As noted above for linux, you might be better off downloading an older version. SWIG 2.0.4 seems to have a bug that stops Pivy building. See first message in this digest: https://sourceforge.net/mailarchive/message.php?msg_id=28114815

This can be corrected by editing the 2 source locations to add dereferences: *arg4, *arg5 in place of arg4, arg5. Now Pivy should build:

Windows
Assuming you are using Visual Studio 2005 or later you should open a command prompt with 'Visual Studio 2005 Command prompt' from the Tools menu. If the Python interpreter is not yet in the system path do

To get pivy working you should get the latest sources from the project's repository:

Then you need a tool called SWIG to generate the C++ code for the Python bindings. It is recommended to use version 1.3.25 of SWIG, not the latest version, because at the moment pivy will only function correctly with 1.3.25. Download the binaries for 1.3.25 from http://www.swig.org. Then unpack it and from the command line add it to the system path

and set COINDIR to the appropriate path

On Windows the pivy config file expects SoWin instead of SoQt as default. I didn't find an obvious way to build with SoQt, so I modified the file setup.py directly. In line 200 just remove the part 'sowin' : ('gui._sowin', 'sowin-config', 'pivy.gui.') (do not remove the closing parenthesis).

After that go to the pivy sources and call

which creates the source files. You may run into a compiler error several header files couldn't be found. In this case adjust the INCLUDE variable

and if the SoQt headers are not in the same place as the Coin headers also

and finally the Qt headers

If you are using the Express Edition of Visual Studio you may get a python keyerror exception. In this case you have to modify a few things in msvccompiler.py located in your python installation.

Go to line 122 and replace the line

with

Then retry again. If you get a second error like

you must also replace line 128

with

Retry once again. If you get again an error like

then you should check the environment variables DISTUTILS_USE_SDK and MSSDK with

If not yet set then just set it e.g. to 1

Now, you may run into a compiler error where a 'const char*' cannot be converted in a 'char*'. To fix that you just need to write a 'const' before in the appropriate lines. There are six lines to fix. After that copy the generated pivy directory to a place where the python interpreter in FreeCAD can find it.

Usage
To check if Pivy is correctly installed:

To have Pivy access the FreeCAD scenegraph do the following:

You can now explore the FCSceneGraph with the dir command.

Additonal Documentation
Unfortunately documentation about pivy is still almost nonexistant on the net. But you might find Coin documentation useful, since pivy simply translate Coin functions, nodes and methods in python, everything keeps the same name and properties, keeping in mind the difference of syntax between C and python:


 * https://bitbucket.org/Coin3D/coin/wiki/Documentation - Coin3D API Reference
 * http://www-evasion.imag.fr/~Francois.Faure/doc/inventorMentor/sgi_html/index.html - The Inventor Mentor - The "bible" of Inventor scene description language.

You can also look at the Draft.py file in the FreeCAD Mod/Draft folder, since it makes big use of pivy.

pyCollada

 * homepage: http://pycollada.github.com
 * license: BSD
 * optional, needed to enable import and export of Collada (.DAE) files

pyCollada is a python library that allow programs to read and write Collada (*.DAE) files. When pyCollada is installed on your system, FreeCAD will be able to handle importing and exporting in the Collada file format.

Installation
Pycollada is usually not yet available in linux distributions repositories, but since it is made only of python files, it doesn't require compilation, and is easy to install. You have 2 ways, or directly from the official pycollada git repository, or with the easy_install tool.

Linux
In either case, you'll need the following packages already installed on your system:

With easy_install
Assuming you have a complete python installation already, the easy_install utility should be present already:

You can check if pycollada was correctly installed by issuing in a python console:

If it returns nothing (no error message), then all is OK

Windows
On Windows since 0.15 pycollada is included in both the FreeCAD release and developer builds so no additional steps are necessary.

Mac OS
If you are using the Homebrew build of FreeCAD you can install pycollada into your system Python using pip.

If you need to install pip:

Install pycollada:

If you are using a binary version of FreeCAD, you can tell pip to install pycollada into the site-packages inside FreeCAD.app:

or after downloading the pycollada code

IfcOpenShell

 * homepage: http://www.ifcopenshell.org
 * license: LGPL
 * optional, needed to extend import abilities of IFC files

IFCOpenShell is a library currently in development, that allows to import (and soon export) Industry foundation Classes (*.IFC) files. IFC is an extension to the STEP format, and is becoming the standard in BIM workflows. When ifcopenshell is correctly installed on your system, the FreeCAD Arch Module will detect it and use it to import IFC files, instead of its built-in rudimentary importer. Since ifcopenshell is based on OpenCasCade, like FreeCAD, the quality of the import is very high, producing high-quality solid geometry.

Installation
Since ifcopenshell is pretty new, you'll likely need to compile it yourself.

Linux
You will need a couple of development packages installed on your system in order to compile ifcopenshell:

but since FreeCAD requires all of them too, if you can compile FreeCAD, you won't need any extra dependency to compile IfcOpenShell.

Grab the latest source code from here:

The build process is very easy:

or, if you are using oce instead of opencascade:

Since ifcopenshell is made primarily for Blender, it uses python3 by default. To use it inside FreeCAD, you need to compile it against the same version of python that is used by FreeCAD. So you might need to force the python version with additional cmake parameters (adjust the python version to yours):

Then:

You can check that ifcopenshell was correctly installed by issuing in a python console:

If it returns nothing (no error message), then all is OK

Windows
Note: Official FreeCAD installers obtained from the FreeCAD website/github page now contain ifcopenshell already.

Copied from the IfcOpenShell README file

Users are advised to use the Visual Studio .sln file in the win/ folder. For Windows users a prebuilt Open CASCADE version is available from the http://opencascade.org website. Download and install this version and provide the paths to the Open CASCADE header and library files to MS Visual Studio C++.

For building the IfcPython wrapper, SWIG needs to be installed. Please download the latest swigwin version from http://www.swig.org/download.html. After extracting the .zip file, please add the extracted folder to the PATH environment variable. Python needs to be installed, please provide the include and library paths to Visual Studio.

Verweise
Tutorium Import/Export IFC - compiling IfcOpenShell

ODA Konverter (vormals Teigha Konverter)

 * Homepage: https://www.opendesign.com/guestfiles/oda_file_converter
 * Lizenz: Freeware
 * Optional, wird verwendet, um den Import und Export von DWG Dateien zu ermöglichen

Der ODA Konverter ist ein kleines, frei verfügbares Programm, das die Konvertierung zwischen verschiedenen Versionen von DWG und DXF Dateien ermöglicht. FreeCAD kann es verwenden, um DWG Import und Export anzubieten, indem es DWG Dateien in das DXF Format unter der Oberfläche konvertiert und dann seinen Standard DXF Importer verwendet, um den Dateiinhalt zu importieren. Es gelten die Einschränkungen des DXF Importeur.

Installation
Auf allen Plattformen, nur durch Installation des entsprechenden Pakets von https://www.opendesign.com/guestfiles/oda_file_converter. Nach der Installation, wenn das Dienstprogramm nicht automatisch von FreeCAD gefunden wird, musst Du möglicherweise den Pfad zur ausführbaren Konverterdatei manuell einstellen, öffne Bearbeiten → Einstellungen → Import-Export → DWG und fülle "Pfad zum Teigha File Converter" entsprechend.