FEAT: switch the repo to STK 13.0.0

.github/workflows/ci_cd_night.yml

@@ -31,7 +31,7 @@ env:
   MINIMUM_PYTHON_VERSION: '3.10'
   PYSTK_DIR: '/home/stk/pystk'
   QUARTO_VERSION: '1.5.55'
-  STK_DOCKER_IMAGE: 'ansys/stk-12.10:dev-ubuntu22.04'
+  STK_DOCKER_IMAGE: 'ansys/stk-13.0:dev-ubuntu22.04'
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -69,7 +69,7 @@ jobs:
   doc-build:
     name: "Doc build"
     runs-on: [self-hosted, pystk]
-    timeout-minutes: 90
+    timeout-minutes: 360
     needs: build-wheelhouse
     permissions:
       contents: read

.github/workflows/ci_cd_pr.yml

@@ -11,7 +11,7 @@ env:
   MINIMUM_PYTHON_VERSION: '3.10'
   PYSTK_DIR: '/home/stk/pystk'
   QUARTO_VERSION: '1.5.55'
-  STK_DOCKER_IMAGE: 'ansys/stk-12.10:dev-ubuntu22.04'
+  STK_DOCKER_IMAGE: 'ansys/stk-13.0:dev-ubuntu22.04'
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -37,6 +37,7 @@ jobs:
       - name: "Checkout repository"
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
+          clean: true
           persist-credentials: false
 
       - name: "Update labels"
@@ -121,6 +122,7 @@ jobs:
       - name: "Checkout project"
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
+          clean: true
           persist-credentials: false
 
       - name: "Install jq"
@@ -194,14 +196,15 @@ jobs:
             runner: [self-hosted, pystk]
           - needs-self-hosted-runner: true
             runner: ubuntu-latest
-    timeout-minutes: 90
+    timeout-minutes: 360
     permissions:
       contents: read
     steps:
 
       - name: "Checkout the project"
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
+          clean: true
           persist-credentials: false
 
       - name: "Install Python ${{ env.MAIN_PYTHON_VERSION }}"
@@ -304,15 +307,15 @@ jobs:
           docker exec \
             --workdir ${PYSTK_DIR} \
             "${STK_CONTAINER}" /bin/bash -c \
-            "export BUILD_API=false BUILD_EXAMPLES=true && tox -e doc-links,doc-html"
+            "export BUILD_API=false BUILD_EXAMPLES=true && tox -e doc-clean,doc-links,doc-html"
 
       - name: "Build docs including the 'API' section"
         id: build-doc-with-api
         if: |
           contains(github.event.pull_request.labels.*.name, 'docs:api') &&
           !contains(github.event.pull_request.labels.*.name, 'docs:examples')
         run: |
-            python -m tox -e doc-links,doc-html
+            python -m tox -e doc-clean,doc-links,doc-html
         env:
           BUILD_API: true
           BUILD_EXAMPLES: false
@@ -322,7 +325,7 @@ jobs:
           !contains(github.event.pull_request.labels.*.name, 'docs:examples') &&
           !contains(github.event.pull_request.labels.*.name, 'docs:api')
         run: |
-          python -m tox -e doc-links,doc-html
+          python -m tox -e doc-clean,doc-links,doc-html
         env:
           BUILD_API: false
           BUILD_EXAMPLES: false
@@ -338,7 +341,7 @@ jobs:
           docker exec \
             --workdir ${PYSTK_DIR} \
             "${STK_CONTAINER}" /bin/bash -c \
-            "export BUILD_API=true BUILD_EXAMPLES=true && tox -e doc-links,doc-html"
+            "export BUILD_API=true BUILD_EXAMPLES=true && tox -e doc-clean,doc-links,doc-html"
 
       # If required, combine partially rendered documentation with the nightly
       # build artifacts. Upload the generated documentation as an artifact in
@@ -416,6 +419,7 @@ jobs:
       - name: "Checkout the project"
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
+          clean: true
           persist-credentials: false
 
       - name: "Generate the name of the Docker image and the container"
@@ -458,8 +462,6 @@ jobs:
             "${STK_CONTAINER}" /bin/bash -c \
             "python -m pip install --group tests ."
 
-      # -- Tests
-
       - name: "Run the extensions tests"
         env:
           STK_CONTAINER: ${{ steps.docker.outputs.container }}

.github/workflows/ci_cd_release.yml

@@ -12,7 +12,7 @@ env:
   MINIMUM_PYTHON_VERSION: '3.10'
   PYSTK_DIR: '/home/stk/pystk'
   QUARTO_VERSION: '1.5.55'
-  STK_DOCKER_IMAGE: 'ansys/stk-12.10:dev-ubuntu22.04'
+  STK_DOCKER_IMAGE: 'ansys/stk-13.0:dev-ubuntu22.04'
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -116,7 +116,7 @@ jobs:
     name: "Doc build"
     runs-on: [self-hosted, pystk]
     needs: build-wheelhouse
-    timeout-minutes: 90
+    timeout-minutes: 360
     permissions:
       contents: read
     steps:

CONTRIBUTING.md

@@ -72,11 +72,12 @@ Use the following commands to build the images for your target distribution:
     ~$ docker images
 
     REPOSITORY        TAG                          IMAGE ID       CREATED        SIZE
-    ansys/stk-12.10   dev-ubuntu22.04-python3.13   5a6ca2ffecae   4 hours ago    4.04GB
-    ansys/stk-12.10   dev-ubuntu22.04-python3.12   94bafab28a80   4 hours ago    4.03GB
-    ansys/stk-12.10   dev-ubuntu22.04-python3.11   97bdccd1c2a6   4 hours ago    4.03GB
-    ansys/stk-12.10   dev-ubuntu22.04-pybase       c9fb6e9502df   5 hours ago    4.21GB
-    ansys/stk-12.10   dev-ubuntu22.04              1e26759936b1   5 hours ago    3.42GB
+    ansys/stk-13.0    dev-ubuntu22.04-python3.13   9eea14569958   14 minutes ago   5.33GB
+    ansys/stk-13.0    dev-ubuntu22.04-python3.12   edee06182a7a   15 minutes ago   5.32GB
+    ansys/stk-13.0    dev-ubuntu22.04-python3.11   205043fd378b   16 minutes ago   5.32GB
+    ansys/stk-13.0    dev-ubuntu22.04-python3.10   c4ec5d4bd662   22 minutes ago   5.21GB
+    ansys/stk-13.0    dev-ubuntu22.04-pybase       3e620a3bbaad   25 minutes ago   5.5GB
+    ansys/stk-13.0    dev-ubuntu22.04              d57b49b927df   30 minutes ago   4.71GB
     ```
 
 - **Windows**

doc/source/api/ansys/stk/core/analysis_workbench/AnalysisWorkbenchComponentProvider.rst

@@ -291,14 +291,14 @@ Create a new Custom Script Vector
     customScript = VectFactory.create("Script", "Description", VectorType.CUSTOM_SCRIPT)
     # Initialization script if needed
     # customScript.InitializationScriptFile = ''
-    trainingSamplesDir = r"C:\Program Files\AGI\STK 12\Data\Resources\stktraining\samples"
+    trainingSamplesDir = r"C:\Program Files\AGI\STK_ODTK 13\Data\Resources\stktraining\samples"
     scriptFilePath = r"\Heliograph\Scripting\VectorTool\Vector\vector.vbs"
     customScript.script_file = trainingSamplesDir + scriptFilePath
     if customScript.is_valid is False:
         print("Script component not valid!")
         from os import getenv
 
-        customScriptingDir = r"C:\Users\%s\Documents\STK 12\Config\Scripting\VectorTool" % getenv("USERNAME")
+        customScriptingDir = r"C:\Users\%s\Documents\STK_ODTK 13\Config\Scripting\VectorTool" % getenv("USERNAME")
         print(r"Copy vbs file from " + trainingSamplesDir + scriptFilePath + r" to " + customScriptingDir)
 
 

doc/source/api/ansys/stk/core/analysis_workbench/SpatialAnalysisToolGridCoordinateDefinition.rst

@@ -21,8 +21,6 @@ Overview
             * - :py:attr:`~ansys.stk.core.analysis_workbench.SpatialAnalysisToolGridCoordinateDefinition.set_custom`
               - Set grid values type to custom values.
             * - :py:attr:`~ansys.stk.core.analysis_workbench.SpatialAnalysisToolGridCoordinateDefinition.set_grid_values_fixed_number_of_steps`
-              - Do not use this method, as it is deprecated. Use SetGridValuesFixedNumberOfStepsEx.
-            * - :py:attr:`~ansys.stk.core.analysis_workbench.SpatialAnalysisToolGridCoordinateDefinition.set_fixed_number_of_steps`
               - Set grid values type to fixed number of steps with min and max as Quantity.
             * - :py:attr:`~ansys.stk.core.analysis_workbench.SpatialAnalysisToolGridCoordinateDefinition.set_fixed_step`
               - Set grid values type to fixed step.
@@ -83,27 +81,9 @@ Method detail
 
         :obj:`~SpatialAnalysisToolGridValuesCustom`
 
-.. py:method:: set_grid_values_fixed_number_of_steps(self, min: float, max: float, num_steps: int) -> SpatialAnalysisToolGridValuesFixedNumberOfSteps
+.. py:method:: set_grid_values_fixed_number_of_steps(self, min: Quantity, max: Quantity, num_steps: int) -> SpatialAnalysisToolGridValuesFixedNumberOfSteps
     :canonical: ansys.stk.core.analysis_workbench.SpatialAnalysisToolGridCoordinateDefinition.set_grid_values_fixed_number_of_steps
 
-    Do not use this method, as it is deprecated. Use SetGridValuesFixedNumberOfStepsEx.
-
-    :Parameters:
-
-        **min** : :obj:`~float`
-
-        **max** : :obj:`~float`
-
-        **num_steps** : :obj:`~int`
-
-
-    :Returns:
-
-        :obj:`~SpatialAnalysisToolGridValuesFixedNumberOfSteps`
-
-.. py:method:: set_fixed_number_of_steps(self, min: Quantity, max: Quantity, num_steps: int) -> SpatialAnalysisToolGridValuesFixedNumberOfSteps
-    :canonical: ansys.stk.core.analysis_workbench.SpatialAnalysisToolGridCoordinateDefinition.set_fixed_number_of_steps
-
     Set grid values type to fixed number of steps with min and max as Quantity.
 
     :Parameters:

doc/source/api/ansys/stk/core/analysis_workbench/SpatialAnalysisToolGridValuesFixedNumberOfSteps.rst

@@ -20,12 +20,8 @@ Overview
             :header-rows: 0
             :widths: auto
 
-            * - :py:attr:`~ansys.stk.core.analysis_workbench.SpatialAnalysisToolGridValuesFixedNumberOfSteps.max`
-              - Do not use this property, as it is deprecated. Use MaxEx.
             * - :py:attr:`~ansys.stk.core.analysis_workbench.SpatialAnalysisToolGridValuesFixedNumberOfSteps.maximum`
               - Maximum coordinate value as Quantity.
-            * - :py:attr:`~ansys.stk.core.analysis_workbench.SpatialAnalysisToolGridValuesFixedNumberOfSteps.min`
-              - Do not use this property, as it is deprecated. Use MinEx.
             * - :py:attr:`~ansys.stk.core.analysis_workbench.SpatialAnalysisToolGridValuesFixedNumberOfSteps.minimum`
               - Minimum coordinate value as Quantity.
             * - :py:attr:`~ansys.stk.core.analysis_workbench.SpatialAnalysisToolGridValuesFixedNumberOfSteps.number_of_steps`
@@ -44,24 +40,12 @@ Import detail
 Property detail
 ---------------
 
-.. py:property:: max
-    :canonical: ansys.stk.core.analysis_workbench.SpatialAnalysisToolGridValuesFixedNumberOfSteps.max
-    :type: float
-
-    Do not use this property, as it is deprecated. Use MaxEx.
-
 .. py:property:: maximum
     :canonical: ansys.stk.core.analysis_workbench.SpatialAnalysisToolGridValuesFixedNumberOfSteps.maximum
     :type: Quantity
 
     Maximum coordinate value as Quantity.
 
-.. py:property:: min
-    :canonical: ansys.stk.core.analysis_workbench.SpatialAnalysisToolGridValuesFixedNumberOfSteps.min
-    :type: float
-
-    Do not use this property, as it is deprecated. Use MinEx.
-
 .. py:property:: minimum
     :canonical: ansys.stk.core.analysis_workbench.SpatialAnalysisToolGridValuesFixedNumberOfSteps.minimum
     :type: Quantity

doc/source/api/ansys/stk/core/analysis_workbench/TimeToolTimeArrayFiltered.rst

@@ -14,6 +14,19 @@ Overview
 
 .. tab-set::
 
+    .. tab-item:: Methods
+
+        .. list-table::
+            :header-rows: 0
+            :widths: auto
+
+            * - :py:attr:`~ansys.stk.core.analysis_workbench.TimeToolTimeArrayFiltered.get_filter_interval_list_or_interval`
+              - Get the interval(s) used to filter samples (being either an Interval or an IntervalList) when FilterType is set to Skip Intervals.
+            * - :py:attr:`~ansys.stk.core.analysis_workbench.TimeToolTimeArrayFiltered.set_filter_interval`
+              - Set the interval used to filter samples when FilterType is set to Skip Intervals when using only one interval.
+            * - :py:attr:`~ansys.stk.core.analysis_workbench.TimeToolTimeArrayFiltered.set_filter_interval_list`
+              - Set the interval list used to filter samples when FilterType is set to Skip Intervals when using a set of intervals.
+
     .. tab-item:: Properties
 
         .. list-table::
@@ -22,8 +35,6 @@ Overview
 
             * - :py:attr:`~ansys.stk.core.analysis_workbench.TimeToolTimeArrayFiltered.count`
               - Specify the number of times skipped between accepted samples when FilterType is set to Skip Count...
-            * - :py:attr:`~ansys.stk.core.analysis_workbench.TimeToolTimeArrayFiltered.filter_interval_list`
-              - The interval list used to filter samples when FilterType is set to Skip Intervals.
             * - :py:attr:`~ansys.stk.core.analysis_workbench.TimeToolTimeArrayFiltered.filter_type`
               - Skip Time Steps filter type omits from filtered time array any times that fall within specified time step of last accepted time sample. Skip Count filter type omits specified number of time samples since last accepted time sample...
             * - :py:attr:`~ansys.stk.core.analysis_workbench.TimeToolTimeArrayFiltered.include_interval_stop_times`
@@ -52,12 +63,6 @@ Property detail
 
     Specify the number of times skipped between accepted samples when FilterType is set to Skip Count...
 
-.. py:property:: filter_interval_list
-    :canonical: ansys.stk.core.analysis_workbench.TimeToolTimeArrayFiltered.filter_interval_list
-    :type: ITimeToolTimeIntervalList
-
-    The interval list used to filter samples when FilterType is set to Skip Intervals.
-
 .. py:property:: filter_type
     :canonical: ansys.stk.core.analysis_workbench.TimeToolTimeArrayFiltered.filter_type
     :type: EventArrayFilterType
@@ -83,3 +88,53 @@ Property detail
     The number of steps skipped between accepted samples when FilterType is set to Skip Time Steps.
 
 
+Method detail
+-------------
+
+
+
+
+
+.. py:method:: get_filter_interval_list_or_interval(self) -> IAnalysisWorkbenchComponent
+    :canonical: ansys.stk.core.analysis_workbench.TimeToolTimeArrayFiltered.get_filter_interval_list_or_interval
+
+    Get the interval(s) used to filter samples (being either an Interval or an IntervalList) when FilterType is set to Skip Intervals.
+
+    :Returns:
+
+        :obj:`~IAnalysisWorkbenchComponent`
+
+
+
+
+
+.. py:method:: set_filter_interval(self, intvl: ITimeToolTimeInterval) -> None
+    :canonical: ansys.stk.core.analysis_workbench.TimeToolTimeArrayFiltered.set_filter_interval
+
+    Set the interval used to filter samples when FilterType is set to Skip Intervals when using only one interval.
+
+    :Parameters:
+
+        **intvl** : :obj:`~ITimeToolTimeInterval`
+
+
+    :Returns:
+
+        :obj:`~None`
+
+.. py:method:: set_filter_interval_list(self, intvls: ITimeToolTimeIntervalList) -> None
+    :canonical: ansys.stk.core.analysis_workbench.TimeToolTimeArrayFiltered.set_filter_interval_list
+
+    Set the interval list used to filter samples when FilterType is set to Skip Intervals when using a set of intervals.
+
+    :Parameters:
+
+        **intvls** : :obj:`~ITimeToolTimeIntervalList`
+
+
+    :Returns:
+
+        :obj:`~None`
+
+
+