Introduction

This repo is a fork of mikedh/occmodel which itself is a fork of tenko/occmodel. This project's primary purpose is for upgrading occmodel to the most recent version of OpenCASCADE Community Edition (OCE). In addition it is going be used to explore using cython to wrap the VTK interface package in the 0.17 release of OCE. VTK provides a superior rendering engine option for OCE topological shapes.

Install

Note, if you want to use VTK, OCE and occmdel in a Conda environment you may want to checkout the conda-env branch and follow the instructions in the README.rst file, if not read on.

Since this code is to be built against the most recent version of OCE, you will most likely need to build OCE from source. See below for detailed instructions. There is also a dependency on VTK, you can either install VTK via yum/apt-get or build it yourself. I would recommend building it yourself as installing VTK via a package manager pulls along a ton of other packages (at least in Fedora it does) that you most likely don't need at this time. If and when the conda VTK package is updated to 6.x from 5.10, you will also be able to build OCE against that, in the meantime see below for VTK build instructions.

The following instructions are only for building and installing on Linux (specifically Fedora). Windows and Mac users will need to adjust as necessary. I have not tried to build and install VTK, OCE or occmodel on Windows or Mac and have no idea how to go about doing that.

Note, rather than installing OCE and VTK into the the default location (/usr/local), I'm using an alternative location (/opt/cad-lib) to make it easier to update and/or uninstall if need be.

Building VTK:

VTK Required Packages: cmake gcc-c++ mesa-libGLU-devel libXmu-devel python-devel

• If building VTK with Qt4 integration add: qt-devel qt-webkit-devel
• If building VTK with Qt5 integration add: qt5-qtbase-devel qt5-qttools-devel qt5-qtwebkit-devel

Optional Packages: cmake-gui doxygen graphviz-devel

1. git clone https://github.com/Kitware/VTK.git

2. cd VTK; git checkout -b v6.2.0 tags/v6.2.0

3. mkdir build-v6.2.0; cd build-v6.2.0

4. CMake command for building with Qt4:

   cmake \

   -DVTK_QT_VERSION:STRING=4 \

   -DCMAKE_INSTALL_PREFIX:PATH=/opt/cad-lib/vtk-6.2 \

   -DQT_QMAKE_EXECUTABLE:PATH=/usr/bin/qmake-qt4 \

   -DVTK_Group_Qt:BOOL=ON \

   -DBUILD_SHARED_LIBS:BOOL=ON \

   -DCMAKE_BUILD_TYPE:STRING=RELEASE \

   -DVTK_WRAP_PYTHON:BOOL=ON \

   -DBUILD_DOCUMENTATION:BOOL=OFF \

   ..

5. CMake command for building with Qt5:

   cmake \

   -DVTK_QT_VERSION:STRING=5 \

   -DCMAKE_INSTALL_PREFIX:PATH=/opt/cad-lib/vtk-6.2 \

   -DQT_QMAKE_EXECUTABLE:PATH=/usr/bin/qmake-qt5 \

   -DVTK_Group_Qt:BOOL=ON \

   -DCMAKE_PREFIX_PATH:PATH=/usr/lib64/cmake \

   -DBUILD_SHARED_LIBS:BOOL=ON \

   -DCMAKE_BUILD_TYPE:STRING=RELEASE \

   -DVTK_WRAP_PYTHON:BOOL=ON \

   -DBUILD_DOCUMENTATION:BOOL=OFF \

   ..

6. make -j$(nproc)

7. make install

To install the VTK python bindings into a virtualenv, activate your desired virtualenv and run:

add2virtualenv /opt/cad-lib/vtk-6.2/lib/python2.7/site-packages

Or if you are using [ana|mini]conda:

conda develop /opt/cad-lib/vtk-6.2/lib/python2.7/site-packages

If you want to use this build of VTK as your default VTK package you may also want to do the following things:

1. Create a conf file in /etc/ld.so.conf.d and reconfigure the dynamic linker run-time bindings

   su -c "echo '/opt/cad-lib/vtk-6.2/lib' >> /etc/ld.so.conf.d/vtk.conf; ldconfig"

2. Symlink the VTK header file directory to /usr/include

   ln -s /opt/cad-lib/vtk-6.2/include/vtk-6.2 /usr/include

3. And in some situations you may need to add VTK libray directory to the LD_LIBRARY_PATH variable in your .bash_profile.

   LD_LIBRARY_PATH=/opt/cad-lib/oce-0.17/lib:$LD_LIBRARY_PATH

Building OCE:

OCE Required Packages: cmake gcc-c++ mesa-libGLU-devel freetype-devel tbb-devel

If you don't want to build VTK yourself per the instructions above, add vtk-qt-python to the OCE reqired packages list and remove the DVTK_DIR:PATH setting in the OCE CMake command.

1. git clone https://github.com/tpaviot/oce.git

2. cd oce; git checkout -b OCE-0.17 tags/OCE-0.17

3. mkdir build-OCE-0.17; cd build-OCE-0.17

4. OCE CMake Command:

   cmake \

   -DOCE_WITH_VTK:BOOL=ON \

   -DVTK_DIR:PATH=/opt/cad-lib/vtk-6.2/lib/cmake/vtk-6.2 \

   -DOCE_MULTITHREAD_LIBRARY:STRING=TBB \

   -DOCE_INSTALL_PREFIX:PATH=/opt/cad-lib/oce-0.17 \

   ..

5. make -j$(nproc)

6. make install

If you want to use this build of OCE as you default OCE package you may also want to do the following things:

1. Create a conf file in /etc/ld.so.conf.d and reconfigure the dynamic linker run-time bindings

   su -c "echo '/opt/cad-lib/oce-0.17/lib' >> /etc/ld.so.conf.d/oce-0.17.conf; ldconfig"

2. Symlink the oce header file directory to /usr/include

   ln -s opt/cad-lib/oce-0.17/include /usr/include

3. And in some situations you may need to add the OCE libray directory to the LD_LIBRARY_PATH variable in your .bash_profile.

   LD_LIBRARY_PATH=/opt/cad-lib/oce-0.17/lib:$LD_LIBRARY_PATH

Building and installing occmodel:

To install occmodel into the active virtual environment, simply execute:

pip install git+https://github.com/colonelzentor/occmodel.git

Or if you want the source on your computer for additional hacking:

git clone https://github.com/colonelzentor/occmodel.git

cd occmodel

python setup.py install

Note, if you are hacking on occmodel and want a clean build each time you install, run:

python setup.py build_all; python setup.py install

build_all executes make clean which will remove the build directory and any .so, .o, .pyo, .pyc and .pyd files create during a previous build process.

Examples

The examples directory contains several Jupyter notebooks showing the occmodel API in action. The OCCT_Bottle_Example.ipynb notebook recreates the OpenCASCADE bottle tutorial using occmodel and displays the result in a VTK rendering window. The Step_File_import.ipynb notebook demonstrates importing and displaying a STEP file

The examples directory includes a simple Qt4-based VTK viewer. To use the viewer you will need to install PySide into the active virtualenv. The following command will build PySide against the system level installed Qt4.

pip install pyside --install-option "--qmake=/usr/bin/qmake-qt4" --install-option "--jobs=$(nproc)" -v

Documentation

See the tenko/occmodel Sphinx docs for API documentation.

Currently, the only deviation of this fork from tenko/occmodel is the addition of toVtkActor on OCCBase and the addition of the OCCVtk package. The OCCVtk package only defines one function, shapeToActor(Base occShape).