Merge pull request #1261 from tpaviot/review/prepare-772

Review/prepare 772

Author: tpaviot

CMakeLists.txt

@@ -25,7 +25,7 @@ set(PYTHONOCC_VERSION_MINOR 7)
 set(PYTHONOCC_VERSION_PATCH 2)
 
 #  Empty for official releases, set to -dev, -rc1, etc for development releases
-set(PYTHONOCC_VERSION_DEVEL -dev)
+set(PYTHONOCC_VERSION_DEVEL )
 
 # set OCCT version
 set(OCCT_VERSION_MAJOR 7)

INSTALL.md

@@ -1,91 +1,105 @@
-Overview
---------
-
-pythonOCC is a python library whose purpose is to provide 3D modeling features.
-It's intended to
-developers who aim at developing a complete CAD/PLM application, and to
-engineers who want to have a total control over the data during complex design
-activities.
-
-About this document
--------------------
-
-This file explains how to build pythonocc-core from source on Windows, Linux or
-MacOSX platforms.
+Build pythonocc-7.7.2 from scratch on a fresh Ubuntu 22.04 install
+------------------------------------------------------------------
 
 Requirements
 ------------
 
-pythonOCC needs the following libraries or programs to be installed before you
+pythonOCC-7.7.2 needs the following libraries or programs to be installed before you
 can compile/use it:
 
-*   the python programming language (<https://www.python.org>). Python 3.x is required.
+*   the python programming language (<https://www.python.org>). Python 3.8 or more is required.
 
-*   OpenCascade 7.7.0 (<https://dev.opencascade.org>)
+*   OpenCascade 7.7.2 (<https://dev.opencascade.org>)
 
-    IMPORTANT: OpenCASCADE has to be compiled using flag -D BUILD_RELEASE_DISABLE_EXCEPTIONS=OFF
+*   SWIG 4.1.1 (<https://www.swig.org>)
 
-*   SWIG 4.0.2 (<https://www.swig.org>)
+*   rapidjson (<https://rapidjson.org/>) for Gltf import/export
 
-Optional
---------
-
-If you want to benefit from a 3D graphical rendering, you will need a GUI manager, e.g. PyQt, PySide or wxPython.
-
-Create a local copy of the repository
--------------------------------------
+*   cmake
 
+All the necessary libraries can be downloaded/installed using apt:
 ```bash
-git clone https://github.com/tpaviot/pythonocc-core.git
+$ sudo apt-get update
+$ sudo apt-get install -y wget libglu1-mesa-dev libgl1-mesa-dev libxmu-dev libxi-dev build-essential cmake libfreetype6-dev tk-dev python3-dev rapidjson-dev python3 git python3-pip libpcre2-dev
 ```
 
-pythonocc-core compilation
---------------------------
-
+Build swig
+----------
+The required swgi version is 4.1.1. Unfortunately, the ubuntu ppa only provides an outdated 4.0.2 version. If swig 4.1.1 is not available on your machine, you have to download/build by yourself (depends on libpcre2, previously installed):
 ```bash
-cd pythonocc-core
-mkdir cmake-build
-cd cmake-build
+$ wget http://prdownloads.sourceforge.net/swig/swig-4.1.1.tar.gz
+$ tar -zxvf swig-4.1.1.tar.gz
+$ cd swig-4.1.1
+$ ./configure && make -j4 && make install
 ```
 
-The configuration steps uses cmake:
+Build OpenCascade
+-----------------
+
+Download/extract version 7.7.2 https://git.dev.opencascade.org/gitweb/?p=occt.git;a=snapshot;h=cec1ecd0c9f3b3d2572c47035d11949e8dfa85e2;sf=tgz
 
 ```bash
-cmake ..
+$ wget -o occt-7.7.2.tgz https://git.dev.opencascade.org/gitweb/?p=occt.git;a=snapshot;h=cec1ecd0c9f3b3d2572c47035d11949e8dfa85e2;sf=tgz
+$ tar -zxvf occt-7.7.2.tgz
 ```
 
-By default, cmake looks for oce include headers in /usr/local/include/oce and
-libraries in /usr/local/include/lib. If these paths don't match your
-installation, you have to set OCE_INCLUDE_PATH and OCE_LIB_PATH:
-
+Prepare the build stage:
 ```bash
-cmake -DOCE_INCLUDE_PATH=/your_oce_headers -DOCE_LIB_PATH=/your_lib_dir ..
+$ cd occt-cec1ecd
+$ mkdir cmake-build
+$ cd cmake-build
 ```
 
-And launch the build process
-
+Choose an installation destination. Default is /usr/local, but it is better to set up
+an other folder so that it's easier to work with concurrent versions.
 ```bash
-make
+$ cmake -DINSTALL_DIR=/opt/build/occt772 -DBUILD_RELEASE_DISABLE_EXCEPTIONS=OFF ..
 ```
-
-If you have many cpus, you can increase the compilation speed with:
-
+then
 ```bash
-make -j$ncpus
+$ make -j4
+```
+and finally add the libraries to the system
+```bash
+echo "/opt/build/occt772/lib" >> /etc/ld.so.conf.d/occt.conf
 ```
 
-According to your machine/os/ncpus, the total compilation time should be around 15 minutes.
+Build pythonocc
+---------------
+First create a local copy of the git repository:
+```bash
+git clone https://github.com/tpaviot/pythonocc-core.git
+```
+then
+```bash
+cd xx/pythonocc-core
+mkdir cmake-build && cd cmake-build
 
-Then
+RUN cmake \
+ -DOCCT_INCLUDE_DIR=/opt/build/occt772/include/opencascade \
+ -DOCCT_LIBRARY_DIR=/opt/build/occt772/lib \
+ -DPYTHONOCC_BUILD_TYPE=Release \
+ ..
 
-```bash
-make install
+RUN make -j4 && make install 
 ```
 
-You may require admin privileges to install
+simple test
+-----------
+```
+$ python
+>>> from OCC.Core.gp import gp_Pnt
+>>> p = gp_Pnt(1., 2., 3.)
+>>> p.X()
+1.0
+>>>
+```
 
-```bash
-sudo make install
+additional dependencies
+-----------------------
+Additional python packages are required if you want to benefit from all pythonocc features.
+```
+pip install svgwrite numpy matplotlib PyQt5
 ```
 
 test

NEWS

@@ -1,3 +1,29 @@
+Version 7.7.2 - October 2023
+=============================
+
+This release requires opencascade-7.7.2
+
+* wrapper: port to opencascade-7.7.2
+
+* wrapper: bump swig version to 4.1.1
+
+* wrapper: new wrappers for RWPly, Unitsmethod
+
+* wrapper: handle TCollection_AsciiString, Standard_CString, TCollection_ExtendedString as
+python strings
+
+* wrapper: pickle objects that provide json serializer
+
+* dataexchange: glt importer/exporter, ply exporter, obj exporter
+
+* display: support for PyQt6 and PySide6
+
+* webgl: refactored threejs and x3dom renderer to stay sync with latest releases
+
+* display: new tkinter renderer, making PyQt or wx GUI managers optional
+
+* cmake installer: respect CMake install prefix
+
 Version 7.7.0 - November 2022
 =============================
 

README.md

@@ -2,7 +2,7 @@
 [![Downloads Badge](https://anaconda.org/conda-forge/pythonocc-core/badges/downloads.svg)](https://anaconda.org/conda-forge/pythonocc-core)
 [![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/tpaviot/pythonocc-core.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/tpaviot/pythonocc-core/context:python)
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/67c121324b8d4f37bc27029464c87020)](https://www.codacy.com/app/tpaviot/pythonocc-core?utm_source=github.com&utm_medium=referral&utm_content=tpaviot/pythonocc-core&utm_campaign=Badge_Grade)
-[![Binder](http://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/tpaviot/pythonocc-binderhub/7.7.0)
+[![Binder](http://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/tpaviot/pythonocc-binderhub/7.7.2)
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3605364.svg)](https://doi.org/10.5281/zenodo.3605364)
 
 pythonocc-core
@@ -13,59 +13,54 @@ About
 
 pythonocc provides 3D modeling and dataexchange features. It is intended to CAD/PDM/PLM and BIM related development. It is based on the OpenCascade Technology modeling kernel.
 
-Latest release: [pythonocc-core 7.7.0 (December 2022)](https://github.com/tpaviot/pythonocc-core/releases/tag/7.7.0)
+Latest release: [pythonocc-core 7.7.2 (October 2023)](https://github.com/tpaviot/pythonocc-core/releases/tag/7.7.2)
 
 Features
 --------
 pythonocc provides the following features:
 
 *   a full access from Python to almost all af the thousand OpenCascade C++ classes. Classes and methods/functions share the same names, and, as possible as it can be, the same signature
-*   3D visualization from the most famous Python Gui (pyQt, PySide1 and 2, wxPython)
-*   3D visualization in a web browser using WebGl and/or x3dom renderers
+*   3D visualization from the most famous Python Gui (tkinter, pyQt5 and 6, PySide2 and 6, wxPython)
+*   3D visualization in a web browser using threejs or x3dom frameworks
 *   3D visualization and work within a jupyter notebook
-*   Various utility Python classes/methods for DataExchange, Topology operations, inertia computations etc.
-
-Cite as
--------
-
-pythonocc is widely used in the industrial and academic communities. It is registered as a Zenodo open caccess software (https://zenodo.org/record/7471333) and should be cited as:
-
-Thomas Paviot. (2022). pythonocc (7.7.0). Zenodo. https://doi.org/10.5281/zenodo.3605364
+*   data exchange using most famous formats IGES/STEP/STL/PLY/OBJ/GLTF
+*   various utility Python classes/methods for Topology operations, inertia computations etc.
 
 Try online at mybinder
 ----------------------
+Click [![Binder](http://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/tpaviot/pythonocc-binderhub/7.7.0) to open a jupyter notebook running the latest pythonocc-core 7.7.2, gmesh (<http://gmsh.info/>) and latest IfcOpenshell (<https://github.com/IfcOpenShell/IfcOpenShell/tree/v0.6.0>) dev branch.
 
-Click [![Binder](http://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/tpaviot/pythonocc-binderhub/7.7.0) to open a jupyter notebook running latest pythonocc-core 7.7.0, gmesh (<http://gmsh.info/>) and latest IfcOpenshell (<https://github.com/IfcOpenShell/IfcOpenShell/tree/v0.6.0>) dev branch.
-
-Download/install binaries for Linux/OSX/Windows
------------------------------------------------
-
-pythonocc provides precompiled [conda packages](https://anaconda.org/pythonocc/pythonocc-core) (they depend on third part libraries made available from the dlr-sc and conda-forge conda channels) for python 3.8, 3.9 and 3.10. This will get you up and running in minutes whether you run win32/win64/linux64/osx64. Here is an example for python 3.9:
+Install with conda
+------------------
+pythonocc provides precompiled [conda packages](https://anaconda.org/pythonocc/pythonocc-core) (they depend on third part libraries made available from the conda-forge channel) for python 3.8, 3.9 and 3.10. This will get you up and running in minutes whether you run win32/win64/linux64/osx64. Here is an example for python 3.9:
 
 ```bash
 # first create an environment
 conda create --name=pyoccenv python=3.9
 source activate pyoccenv
-conda install -c conda-forge pythonocc-core=7.7.0
+conda install -c conda-forge pythonocc-core=7.7.2
 ```
 
 Other conda channels may provide pythonocc-core packages, check https://anaconda.org/search?q=pythonocc-core.
 
 Build from source
 -----------------
-
 Read the [INSTALL.md](https://github.com/tpaviot/pythonocc-core/blob/master/INSTALL.md) instructions where you find compilation instructions for all platforms.
 
+
+Cite as
+-------
+pythonocc is widely used in the industrial and academic communities. It is registered as a Zenodo open caccess software (https://zenodo.org/record/7471333) and should be cited as:
+
+Thomas Paviot. (2022). pythonocc (7.7.2). Zenodo. https://doi.org/10.5281/zenodo.3605364
+
 Other pythonocc related resources
 ---------------------------------
-
 *   Demos: python examples, as well as jupyter notebooks <https://github.com/tpaviot/pythonocc-demos>. A good place to start with pythonocc
 *   Docker, binderhub: docker and online jupyter notebooks <https://github.com/tpaviot/pythonocc-binderhub>
 *   Documentation: <https://github.com/tpaviot/pythonocc-documentation>
 *   <https://github.com/tpaviot/pythonocc-generator> automates the production of SWIG interface files used for the OpenCascade python wrapper
 
 License
 -------
-
-You can redistribute it and/or modify it under the terms of the GNU Lesser
-General Public License version 3 as published by the Free Software Foundation.
+You can redistribute it and/or modify it under the terms of the GNU Lesser General Public License version 3 as published by the Free Software Foundation.

src/Display/SimpleGui.py

@@ -81,10 +81,7 @@ def call_function(s, func: Callable) -> None:
         # returns empty classes and functions
         return offscreen_renderer, do_nothing, do_nothing, call_function
 
-    if backend_str in ["wx", "pyside2", "pyside6", "pyqt5", "pyqt6"]:
-        used_backend = load_backend(backend_str)
-    else:  # default to tk in all other cases
-        used_backend = "tk"
+    used_backend = load_backend(backend_str)
 
     # tkinter SimpleGui
     if used_backend == "tk":

src/Display/WebGl/flask_server.py

@@ -125,8 +125,7 @@ def convert_shape(
                 edge_content = ""
                 nbr_vertices = tess.ObjEdgeGetVertexCount(i_edge)
                 edge_point_set = [
-                    tess.GetEdgeVertex(i_edge, i_vert)
-                    for i_vert in range(nbr_vertices)
+                    tess.GetEdgeVertex(i_edge, i_vert) for i_vert in range(nbr_vertices)
                 ]
                 # write to file
                 edge_hash = f"edg{uuid.uuid4().hex}"

src/Display/WebGl/jupyter_renderer.py

@@ -61,7 +61,7 @@
 
 from OCC.Core.Bnd import Bnd_Box
 from OCC.Core.BRepPrimAPI import BRepPrimAPI_MakeSphere
-from OCC.Core.BRepBndLib import brepbndlib_Add
+from OCC.Core.BRepBndLib import brepbndlib
 from OCC.Core.gp import gp_Pnt, gp_Dir
 from OCC.Core.TopoDS import TopoDS_Compound
 from OCC.Core.BRepBuilderAPI import BRepBuilderAPI_MakeVertex
@@ -373,7 +373,7 @@ def _max_dist_from_origin(self):
     def _bounding_box(self, obj, tol=1e-5):
         bbox = Bnd_Box()
         bbox.SetGap(self.tol)
-        brepbndlib_Add(obj, bbox, True)
+        brepbndlib.Add(obj, bbox, True)
         values = bbox.Get()
         return (values[0], values[3], values[1], values[4], values[2], values[5])
 
@@ -1039,9 +1039,7 @@ def Display(self, position=None, rotation=None):
         )
 
         # Set up Controllers
-        self._controller = OrbitControls(
-            controlling=self._camera, target=camera_target, target0=camera_target
-        )
+        self._controller = OrbitControls(controlling=self._camera, target=camera_target)
         # Update controller to instantiate camera position
         self._camera.zoom = camera_zoom
         self._update()

src/Display/backend.py

@@ -25,6 +25,7 @@
 PYSIDE2 = "pyside2"
 PYQT6 = "pyqt6"
 PYSIDE6 = "pyside6"
+TK = "tk"
 
 # backend module
 HAVE_PYQT5, HAVE_PYSIDE2, HAVE_PYQT6, HAVE_PYSIDE6, HAVE_WX = (
@@ -206,7 +207,7 @@ def load_backend(backend_str=None):
         return BACKEND_MODULE
 
     if backend_str is not None:
-        compatible_backends = (PYQT5, PYQT6, PYSIDE2, PYSIDE6, WX)
+        compatible_backends = (PYQT5, PYQT6, PYSIDE2, PYSIDE6, WX, TK)
         if backend_str not in compatible_backends:
             msg = (
                 f"incompatible backend_str specified: {backend_str}\n"
@@ -270,11 +271,8 @@ def load_backend(backend_str=None):
             log.exception("%s backend could not be loaded", backend_str)
             raise ValueError(msg)
 
-    if not HAVE_BACKEND:
-        raise ImportError(
-            "No compliant GUI library could be imported.\n"
-            "Either PyQt5, PyQt6 or wxPython is required."
-        )
+    # finally, return a tk backend, available on all machines
+    return "tk"
 
 
 def get_qt_modules():

src/Extend/TopologyUtils.py

@@ -226,7 +226,9 @@ def _loop_topo(
                     ]
                 else:
                     index_list = filter_orientation_hash_codes[i_hash_code]
-                    unique = not any(i.IsSame(filter_orientation_seq[j]) for j in index_list)
+                    unique = not any(
+                        i.IsSame(filter_orientation_seq[j]) for j in index_list
+                    )
                     if unique:
                         filter_orientation_seq.append(i)
                         index_list.append(len(filter_orientation_seq) - 1)

src/PkgBase/__init__.py

@@ -3,6 +3,6 @@
 PYTHONOCC_VERSION_PATCH = 2
 
 #  Empty for official releases, set to -dev, -rc1, etc for development releases
-PYTHONOCC_VERSION_DEVEL = "-dev"
+PYTHONOCC_VERSION_DEVEL = ""
 
 VERSION = f"{PYTHONOCC_VERSION_MAJOR}.{PYTHONOCC_VERSION_MINOR}.{PYTHONOCC_VERSION_PATCH}{PYTHONOCC_VERSION_DEVEL}"