Extra python modules/it

=Moduli aggiuntivi di Python=

L'interprete Python interno a FreeCAD può facilmente essere esteso aggiungendo dei nuovi moduli all'installazione di Python del proprio sistema. Tali moduli saranno automaticamente individuati e utilizzati da FreeCAD.

Tutti i moduli Python possono essere usati dall'interno di FreeCAD, ma alcuni di loro, elencati in seguito, hanno una particolare importanza perché permettono ai programmi Python l'accesso completo alle funzionalità di base di FreeCAD. Esempi di utilizzo di questi moduli si trovano anche nella pagina dei Modelli di codici.

Note:


 * Adesso Pivy è completamente integrato in tutti i pacchetti di installazione di FreeCAD, e PyQt4 è anche integrato nel pacchetto di installazione di Windows..
 * 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.

__

PyQt4
Homepage: http://www.riverbankcomputing.co.uk/pyqt

PyQt (versione 4) è una libreria di associazioni di Python che permettono ai programmi di accedere, di creare o di modificare le interfacce Qt.

Poiché l'interfaccia di FreeCAD è costruita con Qt, l'installazione di PyQt4 sul proprio sistema permette ai programmi di Python contenuti in FreeCAD di accedere a tutte le interfacce, di modificare le loro parti, di creare dei nuovi widget o di raccogliere informazioni da parti di interfaccia.

PyQt è rilasciato sotto un sistema di licenze multiple, lo stesso sistema usato anche da Qt. In sintesi, esiste una versione commerciale e una versione libera GPL. Se si desidera utilizzarlo per creare programmi commerciali (closed source), è necessario acquistare la licenza commerciale, altrimenti si può semplicemente installare e utilizzare liberamente la versione GPL.

Installazione
Prima di installare PyQt4, è, ovviamente, necessario disporre di un ambiente Python installato e funzionante.

Linux

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

Windows

Il programma può essere scaricato da quì. Prima di installare PyQt4 è necessario installare le librerie Qt e SIP (operazioni da documentare).

Utilizzo
Dopo l'installazione, è possibile verificare che tutto funzioni digitando nella console Python di FreeCAD:

import PyQt4

Per accedere all'interfaccia di FreeCAD, digitare::

from PyQt4 import QtCore,QtGui app = QtGui.qApp FreeCADWindow = app.activeWindow

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)

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: http://pivy.coin3d.org/

Pivy è una libreria binding (di collegamento) di Coin per Python, supportata ufficialmente da Coin.

Coin di per sé è un toolkit per la creazione di applicazioni 3D in OpenGL. È il gruppo di strumenti che FreeCAD usa per disegnare la sua scena 3D sullo schermo.

Installando Pivy sul proprio sistema si permette ai programmi Python di accedere al Scenegraph (grafo di scena) di FreeCAD, di disegnare nuovi oggetti sulla scena e di utilizzare la vasta gamma di strumenti di Coin disponibili per le operazioni di disegno.

Coin è basato sul linguaggio di descrizione della scena di Open Inventor.

In FreeCAD, Pivy viene utilizzato dal modulo Drafting 2D (Disegno 2D) (e anche dal modulo Completo), per cui esso è necessario quando si desidera utilizzare uno qualsiasi degli strumento di questi moduli,.

È importante sapere che FreeCAD utilizza Coin solo per la rappresentazione degli oggetti sullo schermo, e ricordare che in FreeCAD la rappresentazione degli oggetti è separata dalla loro definizione.

Questo significa che Pivy non è in grado di modificare gli oggetti esistenti, né di creare oggetti di FreeCAD validi. Però può essere utilizzato per disegnare sullo schermo tutti i tipi di cose temporanee, come assi, griglie, manipolatori, geometria di costruzione, ecc ..

Pivy, così come Coin, è rilasciato sotto licenza GPL.

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 (oppure checkinstall se lo si utilizza)

Impiega 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 (oppure 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 descritto 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 COINDIR per il percorso appropriato

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

Potete anche esplorare il file Draft.py nella cartella Mod/Draft di FreeCAD, dato che che in esso si fa un grande uso di pivy.

pyCollada
pyCollada è una libreria di Python che permette ai programmi di leggere e di scrivere i file di Collada (*.DAE). Quando pyCollada è installato sul sistema, FreeCAD lo rileva e aggiunge le opzioni di importazione e di esportazione per gestire l'apertura e il salvataggio di file nel formato Collada.

Installazione
Pycollada in genere non è ancora disponibile nei repository delle distribuzioni Linux, ma dato che è composto solo di file Python, non richiede la compilazione, ed è facile da installare. Si può installare in 2 modi, o direttamente dal repository git ufficiale di pycollada, o con lo strumento easy_install.

Linux
In entrambi i casi, è necessario che nel sistema siano già installati i seguenti pacchetti:

python-lxml python-numpy python-dateutil

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

Con easy_install
Supponendo di avere già una installazione completa di Python, l'utilità easy_install dovrebbe essere già presente:

easy_install pycollada

Si può controllare se pycollada è stato installato correttamente digitando in una console python:

import collada

Se non viene restituito nulla (nessun messaggio di errore), allora tutto è OK

Windows
Ancora da documentare

IfcOpenShell
IFCOpenShell è una libreria attualmente in fase di sviluppo, che permette di importare (e presto di esportare) file Industry foundation Classes (*.IFC). IFC è una estensione per il formato STEP, e sta diventando lo standard nei processi di lavoro BIM. Quando ifcopenshell è installato correttamente nel vostro sistema, il modulo Arch di FreeCAD è grado di rilevarlo e usarlo per importare i file IFC. Poiché ifcopenshell si basa su OpenCascade, come FreeCAD, la qualità della importazione è molto buona, producendo geometria solida di alta qualità.

Homepage: http://www.ifcopenshell.org

Installazione
Dato che ifcopenshell è abbastanza recente, dovrete probabilmente compilarla da soli.

Linux
Per compilare ifcopenshell serve che sul sistema siano installati un paio di pacchetti di sviluppo:

liboce-*-dev python-dev swig

ma dato che anche FreeCAD richiede tutti questi pacchetti, se è possibile compilare FreeCAD, non serve alcun dipendenza in più per compilare IfcOpenShell.

Prelevare l'ultimo codice sorgente da qui:

svn co https://ifcopenshell.svn.sourceforge.net/svnroot/ifcopenshell ifcopenshell

Il processo di costruzione è molto semplice:

mkdir ifcopenshell-build cd ifcopenshell-build cmake ../ifcopenshell/cmake

o, se si utilizza Oce invece di OpenCascade:

cmake -DOCC_INCLUDE_DIR=/usr/include/oce ../ifcopenshell/cmake

Siccome ifcopenshell è fatto principalmente per Blender, utilizza python3 di impostazione predefinita. Per usarlo dentro FreeCAD, è necessario compilarlo contro la stessa versione di Python che viene utilizzata da FreeCAD. Quindi potrebbe essere necessario forzare la versione di Python con parametri aggiuntivi cmake (adattare per la vostra versione di Python):

cmake -DOCC_INCLUDE_DIR=/usr/include/oce -DPYTHON_INCLUDE_DIR=/usr/include/python2.7 -DPYTHON_LIBRARY=/usr/lib/python2.7.so ../ifcopenshell/cmake

Poi:

make sudo make install

Si può controllare se ifcopenshell è stato installato correttamente digitando in una console python:

import IfcImport

Se non viene restituito nulla (nessun messaggio di errore), allora tutto è OK

Windows
Copiato dal file README di IfcOpenShell

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.