Merge branch 'developement'

Author: evereux

.gitignore

@@ -145,4 +145,7 @@ logo*
 
 test.py
 
-hasher.py
+hasher.py
+
+# ignore my issues test scripts
+issue*.py

.readthedocs.yaml

@@ -0,0 +1,25 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+   install:
+   - requirements: requirements/requirements-dev.txt

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 0.6.1
+
+* Added human modelling classes SWKHmiWorkbench and SWKHumanCatalog. Please note these are not documented in the CATIA
+  V5 Basic Help file. Example of usage also added.
+* Added new class method Application.input_box(). @ptm-tm
+* fixed test issue with cat materials where catia env has multiple start-up paths.
+* fixed issue with HybridShapeFactory.add_new_sphere for cases where an axis isn't defined.
+* fixes to RenderingMaterials class methods. @deloarts
+* added new enum type geometrical_feature_type to support HybridShapeFactory.get_geometrical_feature_type().
+
 ## 0.6.0
 
 * Removed deprecated method Product.get_products() use Product.products instead.

CONTRIBUTORS.md

@@ -19,3 +19,5 @@ Mithro86
 ptm-tm
 
 marciolrc
+
+whatDdev

docs/conf.py

@@ -36,7 +36,7 @@ def __getattr__(cls, name):
 author = 'Paul Bourne'
 
 # The short X.Y version
-version = '0.6.0'
+version = '0.6.1'
 # The full version, including alpha/beta/rc tags
 release = version
 

docs/examples.rst

@@ -14,6 +14,8 @@ Index
 
 :ref:`DRAFTING EXAMPLES<Example Drafting>`
 
+:ref:`HUMAN MODELLING EXAMPLES<Example Human Modelling>`
+
 :ref:`HYBRID BODIES EXAMPLES<Example Hybrid Bodies>`
 
 :ref:`HYBRID SHAPE FACTORY EXAMPLES<Example Hybrid Shape Factory>`
@@ -22,6 +24,8 @@ Index
 
 :ref:`HYBRID SKETCH & SHAPE FACTORY EXAMPLES<Example Hybrid Sketch Factory & Shape Factory>`
 
+:ref:`INERTIA EXAMPLES<Example Inertia>`
+
 :ref:`LICENSE SETTINGS EXAMPLES<Example License Settings>`
 
 :ref:`LOGGING EXAMPLES<Example Logging>`
@@ -68,6 +72,7 @@ pathlib.Path module.
 `Asssembly Convetor - 001 <https://github.com/evereux/pycatia/blob/master/examples/example__assembly_convetor__001.py>`_
 
 
+
 .. _Example Bom Custom:
 
 BOM CUSTOM EXAMPLES
@@ -81,6 +86,7 @@ Write the contents of a product to a html file.
 `BOM Custom - 001 <https://github.com/evereux/pycatia/blob/master/examples/example__bom_custom_001.py>`_
 
 
+
 .. _Example Constraints:
 
 CONSTRAINTS EXAMPLES
@@ -95,6 +101,7 @@ also show further usage of constraints.
 `Constraints - 001 <https://github.com/evereux/pycatia/blob/master/examples/example__constraints_001.py>`_
 
 
+
 .. _Example Document:
 
 DOCUMENT EXAMPLES
@@ -126,6 +133,7 @@ Close a catia file.
 `Document - 003 <https://github.com/evereux/pycatia/blob/master/examples/example__document__003.py>`_
 
 
+
 .. _Example Drafting:
 
 DRAFTING EXAMPLES
@@ -142,6 +150,21 @@ Drafting: create a border template in the background view of the currently opene
 `Drafting - 001 <https://github.com/evereux/pycatia/blob/master/examples/example__drafting__001.py>`_
 
 
+
+.. _Example Human Modelling:
+
+HUMAN MODELLING EXAMPLES
+------------------------
+
+Human Modelling - Example 1
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Add a female manikin to the product in the sitting position.
+
+`Human Modelling - 001 <https://github.com/evereux/pycatia/blob/master/examples/example__human_modelling__001.py>`_
+
+
+
 .. _Example Hybrid Bodies:
 
 HYBRID BODIES EXAMPLES
@@ -155,6 +178,7 @@ Make body in work object and intersect with another body.
 `Hybrid Bodies - 001 <https://github.com/evereux/pycatia/blob/master/examples/example__hybrid_bodies__001.py>`_
 
 
+
 .. _Example Hybrid Shape Factory:
 
 HYBRID SHAPE FACTORY EXAMPLES
@@ -215,6 +239,18 @@ origin ZX plane.
 `Hybrid Shape Factory - 005 <https://github.com/evereux/pycatia/blob/master/examples/example__hybrid_shape_factory__005.py>`_
 
 
+Hybrid Shape Factory - Example 6
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+How to add a new sphere when a reference axis system isn't required.
+
+Requirements: A geometrical set named "ConstructionGeometry". A point within the ConstructionGeometry named "Point.1".
+
+`Hybrid Shape Factory - 006 <https://github.com/evereux/pycatia/blob/master/examples/example__hybrid_shape_factory__006.py>`_
+
+
+
+
 .. _Example Hybrid Shape Factory & Shape Factory:
 
 HYBRID SHAPE FACTORY & SHAPE FACTORY EXAMPLES
@@ -228,6 +264,7 @@ Hybrid Shape Factory & Shape Factory - Example 1
 `Hybrid Shape Factory & Shape Factory - 001 <https://github.com/evereux/pycatia/blob/master/examples/example__hybrid_shape_factory__shape_factory__001.py>`_
 
 
+
 .. _Example Hybrid Sketch Factory & Shape Factory:
 
 HYBRID SKETCH & SHAPE FACTORY EXAMPLES
@@ -242,6 +279,21 @@ Creates a square in a sketch and fully constrains it. Sketch then used to pad.
 `Hybrid Sketch & Shape Factory - 001 <https://github.com/evereux/pycatia/blob/master/examples/example__hybrid_sketch__shape_factory__001.py>`_
 
 
+
+.. _Example Inertia:
+
+INERTIA EXAMPLES
+----------------
+
+Inertia - Example 1
+~~~~~~~~~~~~~~~~~~~
+
+Measure Inertia of MainBody in CATPArt.
+
+`Inertia - 001 <https://github.com/evereux/pycatia/blob/master/examples/example__inertia__001.py>`_
+
+
+
 .. _Example License Settings:
 
 LICENSE SETTINGS EXAMPLES
@@ -255,6 +307,7 @@ Basic license checking.
 `License Settings - 001 <https://github.com/evereux/pycatia/blob/master/examples/example__license_settings__001.py>`_
 
 
+
 .. _Example Logging:
 
 LOGGING EXAMPLES
@@ -268,6 +321,7 @@ Logging.
 `Logging - 001 <https://github.com/evereux/pycatia/blob/master/examples/example__logging__001.py>`_
 
 
+
 .. _Example Material Interfaces:
 
 MATERIAL INTERFACES EXAMPLES
@@ -288,6 +342,7 @@ Creates a new product and applies the material to it.
 `Material - 001 <https://github.com/evereux/pycatia/blob/master/examples/example__material__001.py>`_
 
 
+
 .. _Example Message Box:
 
 MESSAGE BOX EXAMPLES
@@ -301,6 +356,7 @@ This creates a message box with the buttons abort, retry ignore and displays the
 `Message Box - 001 <https://github.com/evereux/pycatia/blob/master/examples/example__message_box__001.py>`_
 
 
+
 .. _Example Parameters:
 
 PARAMETERS EXAMPLES
@@ -317,6 +373,15 @@ each parameter along with its name, value and its associated parameter set.
 `Parameters - 001 <https://github.com/evereux/pycatia/blob/master/examples/example__parameters__001.py>`_
 
 
+Parameters - Example 2
+~~~~~~~~~~~~~~~~~~~~~~
+
+Change the Length value of parameter named Thickness.
+
+`Parameters - 002 <https://github.com/evereux/pycatia/blob/master/examples/example__parameters__002.py>`_
+
+
+
 .. _Example Product:
 
 PRODUCT EXAMPLES
@@ -377,6 +442,7 @@ Get the Inertia of a product using product.get_technical object and print it's m
 `Product - 006 <https://github.com/evereux/pycatia/blob/master/examples/example__product__006.py>`_
 
 
+
 .. _Example Selection:
 
 SELECTION EXAMPLES
@@ -398,13 +464,21 @@ Prompt the user to select a product and get it's bounding box parameters
 
 
 Selection - Example 2
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~
 
 Usage of the Selection.select_element2 class method which accepts two selection inputs.
 
 `Selection - 002 <https://github.com/evereux/pycatia/blob/master/examples/example__selection__002.py>`_
 
 
+Selection - Example 3
+~~~~~~~~~~~~~~~~~~~~~
+
+Usage of the Selection.select_element2 to select a geometrical feature and report it's properties in a message window.
+
+`Selection - 003 <https://github.com/evereux/pycatia/blob/master/examples/example__selection__003.py>`_
+
+
 
 .. _Example Shape Factory:
 
@@ -428,6 +502,7 @@ Mirror the main body of the part using shape_factory.add_new_symmetry_2.
 `Shape Factory - 002 <https://github.com/evereux/pycatia/blob/master/examples/example__shape_factory__002.py>`_
 
 
+
 .. _Example Space Analysis:
 
 
@@ -458,11 +533,12 @@ Find all points in the CATPart and print to console and export to csv.
 `Example 3 <https://github.com/evereux/pycatia/blob/master/examples/example__space_analysis__003.py>`_
 
 
-SPECS AND GEOMETRY WINDOW EXAMPLES
-----------------------------------
 
 .. _Example Specs And Geometry Window:
 
+SPECS AND GEOMETRY WINDOW EXAMPLES
+----------------------------------
+
 Specs And Geometry Window - Example 1
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -475,6 +551,7 @@ capture and then turned back on.
 `Specs And Geometry Window - 001 <https://github.com/evereux/pycatia/blob/master/examples/example__specs_and_geom_window__001.py>`_
 
 
+
 .. _Example Visual Properties:
 
 VISUAL PROPERTIES EXAMPLES

docs/installation.rst

@@ -14,21 +14,36 @@ The Short Version
 This assumes python 3.9 or later is already installed and you know how and
 when (all the time really) to use `virtual environments <https://docs.python.org/3/tutorial/venv.html>`_.
 
+You can either install pycatia from pypi.org using `pip install` or clone the repository from github.
+
+Do not do both within the same folder structure.
+
+pypi
+~~~~
+
 To install from `pypi <https://pypi.org/>`_::
 
     pip install pycatia
 
+ To upgrade your current installed version::
+
+    pip install pycatia --upgrade
+
+github
+~~~~~~
 
 To get the latest master version from github::
 
     git clone https://github.com/evereux/pycatia.git
+    # change directory into cloned project
+    cd pycatia
+    # install the python virtual env
+    python -m virtualenv env
+    # activate the virtual env
+    env\Scripts\activate
     # install the pycatia requirements
     pip install -r requirements\requirements.txt
 
- To upgrade your current installed version::
-
-    pip install pycatia --upgrade
-
 
 The Long Version
 ----------------
@@ -74,7 +89,7 @@ environment away from the python installation itself.
 
 * Activate the virtual environment::
 
-    env\Scripts\Activate
+    env\Scripts\activate
 
 
 You should see the command prompt change to something like this::