feat: Configure angle as dimension

.github/workflows/ci_cd.yml

@@ -57,7 +57,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest]
-        python-version: ['3.10', '3.11', '3.12']
+        python-version: ['3.10', '3.11', '3.12', '3.13']
     steps:
       - uses: ansys/actions/build-wheelhouse@v8
         with:
@@ -72,7 +72,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        python-version: ['3.10', '3.11', '3.12']
+        python-version: ['3.10', '3.11', '3.12', '3.13']
       fail-fast: false
     steps:
       - uses: ansys/actions/tests-pytest@v8
@@ -108,6 +108,8 @@ jobs:
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
           token: ${{ secrets.GITHUB_TOKEN }}
+          bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
+          bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}
 
   release:
     name: "Release project to private, public PyPI and GitHub"

.pre-commit-config.yaml

@@ -56,4 +56,4 @@ repos:
   hooks:
     - id: add-license-headers
       args:
-      - --start_year=2023
+      - --start_year=2024

CONTRIBUTORS.md

@@ -6,8 +6,8 @@
 
 ## Individual Contributors
 
-* [Sean Pearson](https://github.com/seanpearsonuk)
+* [Alexander Carvalho](https://github.com/acarvalh-work)
+* [Adam Boutin](https://github.com/ansaboutin)
 * [Mainak Kundu](https://github.com/mkundu1)
 * [Prithwish Mukherjee](https://github.com/prmukherj)
-* [Alexander Carvalho](https://github.com/acarvalh-work)
-* [Adam Boutin]([https:](https://github.com/ansaboutin))
+* [Sean Pearson](https://github.com/seanpearsonuk)

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+Copyright (c) 2024 ANSYS, Inc. and/or its affiliates.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

README.rst

@@ -69,7 +69,7 @@ To reach the project support team, email `[email protected] <pyansys.core@a
 Installation
 ------------
 
-The ``ansys.units`` package supports Python 3.10 through Python 3.12 on Windows
+The ``ansys.units`` package supports Python 3.10 through Python 3.13 on Windows
 and Linux.
 
 

doc/source/getting_started/installation.rst

@@ -4,7 +4,7 @@
 Installation
 ============
 
-The ``ansys-units`` package supports Python 3.10 through Python 3.12 on Windows
+The ``ansys-units`` package supports Python 3.10 through Python 3.13 on Windows
 and Linux.
 
 Install the package

examples/00-pyunits/basic_usage.py

@@ -261,7 +261,7 @@
 
 # Combinations of these
 
-sys_units = {dims.MASS: "slug", dims.LENGTH: "ft", dims.ANGLE: "degree"}
+sys_units = {dims.MASS: "slug", dims.LENGTH: "ft"}
 cgs_modified = UnitSystem(base_units=sys_units, copy_from=cgs)
 cgs_modified
 """

src/ansys/units/base_dimensions.py

@@ -19,38 +19,46 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
-"""Provides the ``BaseDimensions`` class."""
+"""
+Provides the ``BaseDimensions`` class.
 
-from enum import Enum
+Supplies all valid base dimensions used in dimensional analysis.
 
+Used as dictionary keys for defining a `Dimensions` object.
+"""
 
-class BaseDimensions(Enum):
-    """
-    Supplies all valid base dimensions used in dimensional analysis.
+from enum import Enum
+import os
 
-    Used as dictionary keys for defining a `Dimensions` object.
+_base_dims = {
+    "MASS": 0,
+    "LENGTH": 1,
+    "TIME": 2,
+    "TEMPERATURE": 3,
+    "TEMPERATURE_DIFFERENCE": 4,
+    "CHEMICAL_AMOUNT": 5,
+    "LIGHT": 6,
+    "CURRENT": 7,
+}
 
-    Attributes
-    ----------
-    MASS
-    LENGTH
-    TIME
-    TEMPERATURE
-    TEMPERATURE_DIFFERENCE
-    ANGLE
-    CHEMICAL_AMOUNT
-    LIGHT
-    CURRENT
-    SOLID_ANGLE
-    """
+_base_dims_with_angle = {
+    "MASS": 0,
+    "LENGTH": 1,
+    "TIME": 2,
+    "TEMPERATURE": 3,
+    "TEMPERATURE_DIFFERENCE": 4,
+    "CHEMICAL_AMOUNT": 5,
+    "LIGHT": 6,
+    "CURRENT": 7,
+    "ANGLE": 8,
+    "SOLID_ANGLE": 9,
+}
 
-    MASS = 0
-    LENGTH = 1
-    TIME = 2
-    TEMPERATURE = 3
-    TEMPERATURE_DIFFERENCE = 4
-    ANGLE = 5
-    CHEMICAL_AMOUNT = 6
-    LIGHT = 7
-    CURRENT = 8
-    SOLID_ANGLE = 9
+BaseDimensions = Enum(
+    "BaseDimensions",
+    (
+        _base_dims_with_angle
+        if os.getenv("PYANSYS_UNITS_ANGLE_AS_DIMENSION")
+        else _base_dims
+    ),
+)

src/ansys/units/quantity.py

@@ -24,6 +24,7 @@
 from __future__ import annotations
 
 import operator
+import os
 from typing import Union
 
 from ansys.units import BaseDimensions, Dimensions
@@ -296,10 +297,16 @@ def _relative_unit_check(self, __value, op: operator = operator.add) -> Quantity
     def __float__(self):
         base_dims = BaseDimensions
         dims = Dimensions
+        if os.getenv("PYANSYS_UNITS_ANGLE_AS_DIMENSION"):
+            angle_dims = {base_dims.ANGLE: 1.0}
+            solid_angle_dims = {base_dims.SOLID_ANGLE: 1.0}
+        else:
+            angle_dims = {}
+            solid_angle_dims = {}
         if self.dimensions in [
             dims(),
-            dims(dimensions={base_dims.ANGLE: 1.0}),
-            dims(dimensions={base_dims.SOLID_ANGLE: 1.0}),
+            dims(dimensions=angle_dims),
+            dims(dimensions=solid_angle_dims),
         ]:
             return get_si_value(self)
         raise InvalidFloatUsage()

src/ansys/units/systems.py

@@ -23,6 +23,8 @@
 
 from __future__ import annotations
 
+import os
+
 from ansys.units import BaseDimensions, _base_units, _unit_systems
 
 
@@ -49,11 +51,9 @@ class UnitSystem:
     TIME
     TEMPERATURE
     TEMPERATURE_DIFFERENCE
-    ANGLE
     CHEMICAL_AMOUNT
     LIGHT
     CURRENT
-    SOLID_ANGLE
     """
 
     def __init__(
@@ -157,15 +157,6 @@ def TEMPERATURE_DIFFERENCE(self):
     def TEMPERATURE_DIFFERENCE(self, new_mass):
         self._set_type(unit_type=BaseDimensions.TEMPERATURE_DIFFERENCE, unit=new_mass)
 
-    @property
-    def ANGLE(self):
-        """Angle unit of the unit system."""
-        return self._ANGLE
-
-    @ANGLE.setter
-    def ANGLE(self, new_mass):
-        self._set_type(unit_type=BaseDimensions.ANGLE, unit=new_mass)
-
     @property
     def CHEMICAL_AMOUNT(self):
         """Chemical Amount unit of the unit system."""
@@ -193,14 +184,25 @@ def CURRENT(self):
     def CURRENT(self, new_mass):
         self._set_type(unit_type=BaseDimensions.CURRENT, unit=new_mass)
 
-    @property
-    def SOLID_ANGLE(self):
-        """Solid Angle unit of the unit system."""
-        return self._SOLID_ANGLE
+    if os.getenv("PYANSYS_UNITS_ANGLE_AS_DIMENSION"):
+
+        @property
+        def ANGLE(self):
+            """Angle unit of the unit system."""
+            return self._ANGLE
+
+        @ANGLE.setter
+        def ANGLE(self, new_mass):
+            self._set_type(unit_type=BaseDimensions.ANGLE, unit=new_mass)
+
+        @property
+        def SOLID_ANGLE(self):
+            """Solid Angle unit of the unit system."""
+            return self._SOLID_ANGLE
 
-    @SOLID_ANGLE.setter
-    def SOLID_ANGLE(self, new_mass):
-        self._set_type(unit_type=BaseDimensions.SOLID_ANGLE, unit=new_mass)
+        @SOLID_ANGLE.setter
+        def SOLID_ANGLE(self, new_mass):
+            self._set_type(unit_type=BaseDimensions.SOLID_ANGLE, unit=new_mass)
 
     def __repr__(self):
         units = ""

src/ansys/units/unit.py

@@ -407,10 +407,11 @@ def _units_to_dim(
         if unit_term in _base_units:
             idx = _base_units[unit_term]["type"]
 
-            if BaseDimensions[idx] in dimensions:
-                dimensions[BaseDimensions[idx]] += unit_term_exponent
-            else:
-                dimensions[BaseDimensions[idx]] = unit_term_exponent
+            if idx in list(BaseDimensions.__members__.keys()):
+                if BaseDimensions[idx] in dimensions:
+                    dimensions[BaseDimensions[idx]] += unit_term_exponent
+                else:
+                    dimensions[BaseDimensions[idx]] = unit_term_exponent
         # Retrieve derived unit composition unit string and SI factor.
         elif unit_term in _derived_units:
             # Recursively parse composition unit string

tests/lib_compare/test_angle_units.py

@@ -45,7 +45,8 @@ def test_pint_angles_are_dimensionless():
     assert str(angle_in_radians_dimensions) == "dimensionless"
 
 
-def test_pyunits_angles_have_angle_dimensions():
+def test_pyunits_angles_have_angle_dimensions(monkeypatch):
+    monkeypatch.setenv("PYANSYS_UNITS_ANGLE_AS_DIMENSION", "1")
     from ansys.units import BaseDimensions, Dimensions
     from ansys.units.quantity import Quantity
 
@@ -79,7 +80,8 @@ def test_pint_angle_and_dimensionless_are_convertible():
     assert num_deg_rom_rad == util.one_degree_in_radians
 
 
-def test_pyunits_angle_and_dimensionless_are_not_convertible():
+def test_pyunits_angle_and_dimensionless_are_not_convertible(monkeypatch):
+    monkeypatch.setenv("PYANSYS_UNITS_ANGLE_AS_DIMENSION", "1")
     from ansys.units.quantity import IncompatibleDimensions, Quantity
 
     no_dim = Quantity(1.0, "")
@@ -169,7 +171,8 @@ def test_pint_conversion_between_Hz_and_rps_and_radians_per_second():
     # mean is "This is the inevitable outcome of the way we do things."
 
 
-def test_ansunits_frequency_and_angular_frequency_are_not_convertible():
+def test_ansunits_frequency_and_angular_frequency_are_not_convertible(monkeypatch):
+    monkeypatch.setenv("PYANSYS_UNITS_ANGLE_AS_DIMENSION", "1")
     from ansys.units.quantity import IncompatibleDimensions, Quantity
 
     # ansunits avoids the pint complications by simply not allowing

tests/lib_compare/test_dimensions_without_angles.py

@@ -0,0 +1,53 @@
+# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+import ansys.units as pyunits
+
+
+def test_degree_addition():
+    degree = pyunits.Quantity(1.0, "degree")
+    assert not degree.dimensions
+    assert degree.is_dimensionless
+    assert degree + 1 == pyunits.Quantity(58.29577951308232, "degree")
+
+
+def test_radian_addition():
+    radian = pyunits.Quantity(1.0, "radian")
+    assert not radian.dimensions
+    assert radian.is_dimensionless
+    assert radian + 1 == pyunits.Quantity(2.0, "radian")
+    assert (radian + 1).to("degree") == pyunits.Quantity(114.59155902616465, "degree")
+
+
+def test_unit_system_repr():
+    us = pyunits.UnitSystem()
+    us_dict = """MASS: kg
+LENGTH: m
+TIME: s
+TEMPERATURE: K
+TEMPERATURE_DIFFERENCE: delta_K
+CHEMICAL_AMOUNT: mol
+LIGHT: cd
+CURRENT: A
+"""
+
+    assert repr(us) == str(us_dict)

tests/test_quantity.py

@@ -238,7 +238,8 @@ def test_repr():
     assert v.__repr__() == 'Quantity (1.0, "m")'
 
 
-def test_math():
+def test_math(monkeypatch):
+    monkeypatch.setenv("PYANSYS_UNITS_ANGLE_AS_DIMENSION", "1")
     deg = Quantity(90, "degree")
     assert math.sin(deg) == 1.0
 
@@ -620,7 +621,8 @@ def dim_test(units, dim_dict):
     print("-" * 75)
 
 
-def testing_multipliers():
+def testing_multipliers(monkeypatch):
+    monkeypatch.setenv("PYANSYS_UNITS_ANGLE_AS_DIMENSION", "1")
     print(f"{'*' * 25} {testing_multipliers.__name__} {'*' * 25}")
 
     def from_to(from_str, to_str):

tests/test_systems.py

@@ -40,17 +40,18 @@ def test_pre_defined_unit_system():
     assert us.SOLID_ANGLE == "sr"
 
 
-def test_repr():
+def test_repr(monkeypatch):
+    monkeypatch.setenv("PYANSYS_UNITS_ANGLE_AS_DIMENSION", "1")
     us = UnitSystem()
     us_dict = """MASS: kg
 LENGTH: m
 TIME: s
 TEMPERATURE: K
 TEMPERATURE_DIFFERENCE: delta_K
-ANGLE: radian
 CHEMICAL_AMOUNT: mol
 LIGHT: cd
 CURRENT: A
+ANGLE: radian
 SOLID_ANGLE: sr
 """