Extra python modules/it

Questa pagina elenca alcuni moduli Python aggiuntivi o altre parti di software che possono essere scaricati gratuitamente da internet, e che aggiungono funzionalità alla vostra installazione FreeCAD.

PySide (sostituisce PyQt4)

 * homepage (PySide): http://qt-project.org/wiki/PySide
 * licenza: LGPL
 * optional, ma è necessario per diversi moduli: Draft, Arch, Ship, Plot, OpenSCAD, Spreadsheet

PySide (precedentemente PyQt) è richiesto da diversi moduli di FreeCAD per accedere all'interfaccia Qt di FreeCAD. È già incluso nella versione per windows di FreeCAD, e di solito su Linux è installato automaticamente da FreeCAD quando l'installazione viene fatta dai repository ufficiali. Se i moduli Draft, Arch, ecc. sono abilitati, dopo che FreeCAD è installato, significa che PySide (precedentemente PyQt) è presente e non è più necessario fare nulla.

Note:

In FreeCAD, PyQt4 diventerà progressivamente obsoleto dopo la versione 0.13, a favore di PySide, che fa esattamente lo stesso lavoro, ma ha una licenza (LGPL) più compatibile con FreeCAD.

Linux
Il modo più semplice per installare PySide è attraverso il gestore dei pacchetti della propria distribuzione. Su sistemi Debian/Ubuntu, il nome del pacchetto è generalmente python-PySide, mentre per i sistemi basati su RPM viene chiamato pyside. Le dipendenze necessarie (Qt e SIP) si installano automaticamente.

Windows
Il programma può essere scaricato da http://qt-project.org/wiki/Category:LanguageBindings::PySide::Downloads. Prima di installare PyQt4 è necessario installare le librerie Qt e SIP (operazioni da documentare).

MacOSX
PyQt on Mac can be installed via homebrew or port. See CompileOnMac for more information.

Utilizzo
Dopo l'installazione, è possibile verificare che tutto funzioni digitando nella console Python di FreeCAD: import PySide Per accedere all'interfaccia di FreeCAD, digitare: from PySide import QtCore,QtGui FreeCADWindow = FreeCADGui.getMainWindow Quindi si può iniziare ad esplorare l'interfaccia con il comando dir. È possibile aggiungere nuovi elementi, ad esempio un widget personalizzato, con comandi come: FreeCADWindow.addDockWidget(QtCore.Qt.RghtDockWidgetArea,my_custom_widget) Working with Unicode : text = text.encode('utf-8') Working with QFileDialog and OpenFileName : path = FreeCAD.ConfigGet("AppHomePath") OpenName, Filter = PySide.QtGui.QFileDialog.getOpenFileName(None, "Read a txt file", path, "*.txt") Working with QFileDialog and SaveFileName : path = FreeCAD.ConfigGet("AppHomePath") SaveName, Filter = PySide.QtGui.QFileDialog.getSaveFileName(None, "Save a file txt", path, "*.txt")
 * 1) path = FreeCAD.ConfigGet("UserAppData")
 * 1) path = FreeCAD.ConfigGet("UserAppData")

Example of transition from PyQt4 and PySide
PS: these examples of errors were found in the transition PyQt4 to PySide and these corrections were made, other solutions are certainly available with the examples above try: import PyQt4                                       # PyQt4 from PyQt4 import QtGui ,QtCore                    # PyQt4 from PyQt4.QtGui import QComboBox                  # PyQt4 from PyQt4.QtGui import QMessageBox                # PyQt4 from PyQt4.QtGui import QTableWidget, QApplication # PyQt4 from PyQt4.QtGui import *                          # PyQt4 from PyQt4.QtCore import *                         # PyQt4 except Exception: import PySide                                      # PySide from PySide import QtGui ,QtCore                   # PySide from PySide.QtGui import QComboBox                 # PySide from PySide.QtGui import QMessageBox               # PySide from PySide.QtGui import QTableWidget, QApplication # PySide from PySide.QtGui import *                         # PySide from PySide.QtCore import *                        # PySide To access the FreeCAD interface, type : You can add new elements, like a custom widget, with commands like : myNewFreeCADWidget = QtGui.QDockWidget         # create a new dockwidget myNewFreeCADWidget.ui = Ui_MainWindow          # myWidget_Ui             # load the Ui script myNewFreeCADWidget.ui.setupUi(myNewFreeCADWidget) # setup the ui try: app = QtGui.qApp                             # PyQt4 # the active qt window, = the freecad window since we are inside it    FCmw = app.activeWindow                     # PyQt4 # the active qt window, = the freecad window since we are inside it    FCmw.addDockWidget(QtCore.Qt.RightDockWidgetArea,myNewFreeCADWidget) # add the widget to the main window except Exception: FCmw = FreeCADGui.getMainWindow            # PySide # the active qt window, = the freecad window since we are inside it     FCmw.addDockWidget(QtCore.Qt.RightDockWidgetArea,myNewFreeCADWidget) # add the widget to the main window Working with Unicode : try: text = unicode(text, 'ISO-8859-1').encode('UTF-8') # PyQt4 except Exception: text = text.encode('utf-8')                        # PySide Working with QFileDialog and OpenFileName : OpenName = "" try: OpenName = QFileDialog.getOpenFileName(None,QString.fromLocal8Bit("Lire un fichier FCInfo ou txt"),path,"*.FCInfo *.txt") # PyQt4 except Exception: OpenName, Filter = PySide.QtGui.QFileDialog.getOpenFileName(None, "Lire un fichier FCInfo ou txt", path, "*.FCInfo *.txt")#PySide Working with QFileDialog and SaveFileName : SaveName = "" try: SaveName = QFileDialog.getSaveFileName(None,QString.fromLocal8Bit("Sauver un fichier FCInfo"),path,"*.FCInfo") # PyQt4 except Exception: SaveName, Filter = PySide.QtGui.QFileDialog.getSaveFileName(None, "Sauver un fichier FCInfo", path, "*.FCInfo")# PySide The MessageBox: def errorDialog(msg): diag = QtGui.QMessageBox(QtGui.QMessageBox.Critical,u"Error Message",msg ) try: diag.setWindowFlags(PyQt4.QtCore.Qt.WindowStaysOnTopHint) # PyQt4 # this function sets the window before except Exception: diag.setWindowFlags(PySide.QtCore.Qt.WindowStaysOnTopHint)# PySide # this function sets the window before diag.exec_ Working with setProperty (PyQt4) and setValue (PySide) self.doubleSpinBox.setProperty("value", 10.0) # PyQt4 replace to : self.doubleSpinBox.setValue(10.0) # PySide Working with setToolTip self.doubleSpinBox.setToolTip(_translate("MainWindow", "Coordinate placement Axis Y", None)) # PyQt4 replace to : self.doubleSpinBox.setToolTip(_fromUtf8("Coordinate placement Axis Y")) # PySide or : self.doubleSpinBox.setToolTip(u"Coordinate placement Axis Y.")# PySide
 * 1)    diag.setWindowModality(QtCore.Qt.ApplicationModal)       # function has been disabled to promote "WindowStaysOnTopHint"

Documentazione
Ecco alcuni tutorial di PyQt4 (che spiegano come costruire interfacce con Qt Designer da utilizzare con Python):
 * http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/classes.html - il riferimento ufficiale delle API di PyQt4
 * http://www.rkblog.rk.edu.pl/w/p/introduction-pyqt4/ - una semplice introduzione
 * http://www.zetcode.com/tutorials/pyqt4/ - un manuale molto approfondito e completo

Pivy

 * homepage: https://bitbucket.org/Coin3D/coin/wiki/Home
 * licenza: BSD
 * optional, ma è necessario per alcuni moduli di FreeCAD: Draft, Arch

Pivy serve a alcuni moduli per accedere alla visualizzazione 3D di FreeCAD. Su Windows, Pivy è già in impacchettato nel programma di installazione FreeCAD, e su Linux solitamente è installato automaticamente quando si installa FreeCAD da un repository ufficiale. Su MacOSX, purtroppo, è necessario compilare pivy da soli.

Prerequisiti
Credo che prima di compilare Pivy si desideri avere Coin e SoQt installati.

Per compilarlo su Mac è sufficiente installare il pacchetto binario Coin3. Il tentativo di installare Coin da MacPorts è stato problematico: ha cercato di aggiungere un sacco di pacchetti di X Windows e alla fine il tentativo è fallito con un errore di script.

Per Fedora ho trovato un RPM con Coin3

SoQt compilato da codice sorgente funziona bene su Mac e Linux.

Debian & Ubuntu
A partire da Debian Squeeze e Ubuntu Lucid, Pivy sarà disponibile direttamente dai repository ufficiali e questo eviterà un sacco di problemi.

Nel frattempo, è possibile scaricare uno dei pacchetti che abbiamo creato (per Debian e Ubuntu Karmic) e disponibili nelle pagine Download, o compilarlo da soli.

Il modo migliore per compilare facilmente Pivy è quello di prendere il pacchetto sorgente di Debian per Pivy e creare un pacchetto con debuild.

È lo stesso codice sorgente dal sito ufficiale di Pivy, ma la comunità di Debian vi ha fatto diverse aggiunte bug-fixing.

Si compila bene anche su Ubuntu Karmic: http://packages.debian.org/squeeze/python-pivy. Scaricare i file .orig.gz e .diff.gz, poi decomprimerli entrambi, quindi applicare .diff al codice sorgente: andare nella cartella del codice sorgente decompresso di Pivy, e applicare la patch .diff: patch -p1 < ../pivy_0.5.0~svn765-2.diff poi debuild per avere Pivy correttamente costruito in un pacchetto ufficiale installabile. Dopo è sufficiente installare il pacchetto con gdebi.

Altre distribuzioni Linux
Prima di tutto scaricare gli ultimi sorgenti dai repository del progetto: hg clone http://hg.sim.no/Pivy/default Pivy A partire dal marzo 2012, l'ultima versione è Pivy-0.5.

In seguito serve uno strumento chiamato SWIG per generare il codice C++ per i binding di Python. Pivy-0.5 segnala che è stato testato solo con SWIG 1.3.31, 1.3.33, 1.3.35 e 1.3.40. Perciò si può scaricare un tarball del codice sorgente di una di queste vecchie versioni da http://www.swig.org. Poi scompattarlo e da una riga di comando fare (come root): ./configure make make install (or checkinstall if you use it) Impiega appena pochi secondi per costruirsi.

In alternativa, si può provare la costruzione con un SWIG più recente. A partire dal marzo 2012 la versione tipica del repository è la 2.0.4. Pivy presenta un piccolo problema di compilazione con SWIG 2.0.4 su Mac OS (vedere sotto), mentre pare si costruisca bene su Fedora Core 15.

Dopo le operazioni precedenti andare nel sorgente di Pivy e eseguire: python setup.py build per creare i file sorgente. Notare che la generazione può produrre migliaia di avvisi, ma fortunatamente non ci sono errori.

Questo è probabilmente obsoleto, ma si può incorrere in un errore di compilazione in cui una 'const char*' non può essere convertita in una 'char*'. Per risolvere il problema basta scrivere una 'const' prima nelle righe appropriate. Si devono correggere sei righe.

Dopo di che, installare digitando (come root): python setup.py install (or checkinstall python setup.py install) Questo è tutto. Pivy è installato.

Mac OS
Queste istruzioni potrebbero non essere complete. Qualcosa di simile a questo ha funzionato per OS 10,7 dopo marzo 2012. Io uso MacPorts come repository, ma dovrebbero funzionare anche le altre opzioni.

Per quanto riguarda Linux, scaricare l'ultimo codice sorgente: hg clone http://hg.sim.no/Pivy/default Pivy Se non si dispone di hg, è possibile ottenerlo da MacPorts: port install mercurial Poi, come prima, è necessario SWIG. Si tratta di fare: port install swig Ho scoperto che avevo bisogno anche di: port install swig-python Da marzo 2012, la versione di SWIG in MacPorts è la 2.0.4. Come detto in precedenza per Linux, potrebbe essere meglio scaricare una versione precedente. SWIG 2.0.4 sembra avere un bug che blocca la costruzione di Pivy. Vedere il primo messaggio in questa raccolta: https://sourceforge.net/mailarchive/message.php?msg_id=28114815

Questo problema può essere corretto modificando i 2 percorsi del codice sorgente per aggiungere dereferenziazioni: arg4 *, * arg5 al posto di arg4, arg5. Ora si può costruire Pivy: python setup.py build sudo python setup.py install

Windows
Supponendo di utilizzare Visual Studio 2005 o versioni successive è necessario aprire un prompt dei comandi con 'Visual Studio 2005 Command prompt' dal menu Strumenti. Se l'interprete Python non è ancora nel percorso di sistema fare: set PATH=path_to_python_2.5;%PATH% Per avere pivy funzionante si devono scaricare gli ultimi sorgenti dal repository del progetto: svn co https://svn.coin3d.org/repos/Pivy/trunk Pivy Dopo serve lo strumento chiamato SWIG per generare il codice C++ per i binding con Python. Si raccomanda di utilizzare la versione 1.3.25 di SWIG, non l'ultima versione, perché al momento pivy funziona correttamente solo con la 1.3.25. Scaricare i file binari per 1.3.25 da http://www.swig.org. Poi scompattarli e dalla riga di comando aggiungerli al percorso di sistema set PATH=path_to_swig_1.3.25;%PATH% e impostare il percorso appropriato per COINDIR set COINDIR=path_to_coin Su Windows il file di configurazione di pivy si aspetta SoWin invece di SoQt come predefinito. Non ho trovato un modo valido per costruirlo con SoQt, così ho modificato direttamente il file setup.py. Nella riga 200 è sufficiente rimuovere la parte 'sowin': ('gui._sowin', 'sowin-config', 'Pivy.gui.') (non rimuovere le parentesi di chiusura).

Successivamente andare nel sorgente di pivy e eseguire: python setup.py build per creare i file sorgente. Si può incorrere nell'errore di compilazione 'header files couldn't be found' (file di intestazione non trovati). In questo caso, impostare la variabile INCLUDE set INCLUDE=%INCLUDE%;path_to_coin_include_dir e, se le intestazioni di SoQt non sono nella stessa posizione delle intestazioni di Coin, impostare anche set INCLUDE=%INCLUDE%;path_to_soqt_include_dir e infine impostare le intestazioni di Qt set INCLUDE=%INCLUDE%;path_to_qt4\include\Qt Se si utilizza la versione Express Edition di Visual Studio è possibile ottenere un'eccezione di errore di chiave di Python (KeyError). In questo caso è necessario modificare alcune cose in msvccompiler.py situato nella propria installazione di Python.

Andare alla riga 122 e sostituire la riga vsbase = r"Software\Microsoft\VisualStudio\%0.1f" % version con vsbase = r"Software\Microsoft\VCExpress\%0.1f" % version Riprovare di nuovo. Se si ottiene un secondo errore del tipo error: Python was built with Visual Studio 2003;... è necessario sostituire anche la riga 128 self.set_macro("FrameworkSDKDir", net, "sdkinstallrootv1.1") con self.set_macro("FrameworkSDKDir", net, "sdkinstallrootv2.0") Riprovare ancora una volta. Se si ottiene di nuovo un errore quale error: Python was built with Visual Studio version 8.0, and extensions need to be built with the same version of the compiler, but it isn't installed. allora si deve controllare le variabili d'ambiente DISTUTILS_USE_SDK e MSSDK con echo %DISTUTILS_USE_SDK% echo %MSSDK% Se non sono ancora impostate basta impostarle, ad esempio, a 1 set DISTUTILS_USE_SDK=1 set MSSDK=1 Ora, si può incorrere in un errore di compilazione in cui una 'const char *' non può essere convertita in una 'char *'. Per risolvere il problema basta scrivere una 'const' prima nelle righe appropriate. Ci sono sei righe da correggere.

Infine, copiare la directory di pivy generata in un posto dove l'interprete di Python di FreeCAD possa trovarla.

Utilizzo
Per verificare se Pivy è installato correttamente: import pivy Per consentire a Pivy di accedere al grafo di scena (Scenegraph) di FreeCAD effettuare le seguenti operazioni: from pivy import coin App.newDocument # Open a document and a view view = Gui.ActiveDocument.ActiveView FCSceneGraph = view.getSceneGraph # returns a pivy Python object that holds a SoSeparator, the main "container" of the Coin scenegraph FCSceneGraph.addChild(coin.SoCube) # add a box to scene Ora è possibile esplorare FCSceneGraph con il comando dir.

Documentazione aggiuntiva
Purtroppo in rete la documentazione su Pivy è ancora quasi inesistente. Ma può essere utile la documentazione di Coin, in quanto Pivy semplicemente traduce le funzioni di Coin, i nodi e i metodi in Python, tutto mantiene lo stesso nome e le stesse proprietà, tenendo presente la differenza di sintassi tra C e Python:


 * http://doc.coin3d.org/Coin/classes.html - Coin3D API Reference
 * http://www-evasion.imag.fr/~Francois.Faure/doc/inventorMentor/sgi_html/index.html - The Inventor Mentor - La "Bibbia" del linguaggio di descrizione della scena di Inventor.

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: python-lxml python-numpy python-dateutil

From the git repository
git clone git://github.com/pycollada/pycollada.git pycollada cd pycollada sudo python setup.py install

With easy_install
Assuming you have a complete python installation already, the easy_install utility should be present already: easy_install pycollada You can check if pycollada was correctly installed by issuing in a python console: import collada If it returns nothing (no error message), then all is OK

Windows

 * 1) Install Python. While FreeCAD and some other programs come with a bundled version of Python, having a fixed install will help with the next steps. You can get Python here: https://www.python.org/downloads/ . Of course you should pick the right version, in this case that would be 2.6.X, as FreeCAD currently uses 2.6.2 (Personally I went with 2.6.2, and by the way, you can check the version yourself by starting the Python.exe in the bin folder of FreeCAD). You'll also have to add the path of the installation directory into the path variable so you can access Python from the cmd. Now we can install the missing things, in total there are 3 things we need to install: numpy, setuptools, pycollada
 * 2) Fetch numpy here: http://sourceforge.net/projects/numpy/files/NumPy/ . Pick a version which fits to the version used by FreeCAD, there are multiple installers for different Python versions in every numpy version folder, the installer will put numpy into the folder of your Python installation, where FreeCAD can access it as well
 * 3) Fetch setuptools here: https://pypi.python.org/pypi/setuptools (We need to install the setuptools in order to install pycollada in the next step)
 * 4) Unzip the downloaded setuptools  file somewhere
 * 5) Start a cmd with admin permission
 * 6) Navigate to the unpacked setuptools folder
 * 7) Install the setuptools by tipping "Python setup.py install" into the cmd, this will not work when Python is not installed or when the path variable hasn't been configured
 * 8) Fetch pycollada here: https://pypi.python.org/pypi/pycollada/ (has already been posted above) and once again:
 * 9) Unzip the downloaded pycollada file somewhere
 * 10) Start a cmd with admin permission, or use the one you opened not long ago
 * 11) Navigate to the unpacked pycollada folder
 * 12) Install the setuptools by tipping "Python setup.py install" into the cmd


 * Another reference on how to use easy_install: http://jishus.org/?p=452

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: $ sudo easy_install pip Install pycollada: $ sudo 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: $ pip install --target="/Applications/FreeCAD.app/Contents/lib/python2.7/site-packages" pycollada

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: liboce-*-dev python-dev swig 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: svn co https://ifcopenshell.svn.sourceforge.net/svnroot/ifcopenshell ifcopenshell The build process is very easy: mkdir ifcopenshell-build cd ifcopenshell-build cmake ../ifcopenshell/cmake or, if you are using oce instead of opencascade: cmake -DOCC_INCLUDE_DIR=/usr/include/oce ../ifcopenshell/cmake 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): cmake -DOCC_INCLUDE_DIR=/usr/include/oce -DPYTHON_INCLUDE_DIR=/usr/include/python2.7 -DPYTHON_LIBRARY=/usr/lib/python2.7.so ../ifcopenshell/cmake Then: make sudo make install You can check that ifcopenshell was correctly installed by issuing in a python console: import IfcImport If it returns nothing (no error message), then all is OK

Windows
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.

Teigha Converter

 * homepage: http://www.opendesign.com/guestfiles/TeighaFileConverter
 * license: freeware
 * optional, used to enable import and export of DWG files

The Teigha Converter is a small freely available utility that allows to convert between several versions of DWG and DXF files. FreeCAD can use it to offer DWG import and export, by converting DWG files to the DXF format under the hood,then using its standard DXF importer to import the file contents. The restrictions of the DXF importer apply.

Installation
On all platforms, only by installing the appropriate package from http://www.opendesign.com/guestfiles/TeighaFileConverter. After installation, if the utility is not found automatically by FreeCAD, you might need to set the path to the converter executable manually, in the menu Edit -> Preferences -> Draft -> Import/Export options.