Skip to content

Commit

Permalink
feat: security updates dropped for v0.3 or earlier (#1126)
Browse files Browse the repository at this point in the history
Co-authored-by: pyansys-ci-bot <[email protected]>
  • Loading branch information
RobPasMue and pyansys-ci-bot authored Apr 17, 2024
1 parent b61e4f2 commit 7ca0fc3
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 7 deletions.
4 changes: 2 additions & 2 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ SOFTWARE.

| Version | Supported |
| ------- | ------------------ |
| <= 0.2 | :x: |
| 0.3.x | :white_check_mark: |
| <= 0.3 | :x: |
| 0.4.x | :white_check_mark: |
| 0.5.x | :white_check_mark: |
| dev | :white_check_mark: |

## Reporting a Vulnerability
Expand Down
1 change: 1 addition & 0 deletions doc/changelog.d/1126.added.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
feat: security updates dropped for v0.3 or earlier
8 changes: 4 additions & 4 deletions doc/source/examples/01_getting_started/04_modeling.mystnb
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ print(modeler)

You can also launch your own services and connect to them. For information on
connecting to an existing service, see the
[Modeler API](https://geometry.docs.pyansys.com/version/stable/api/ansys/geometry/core/modeler/Modeler.html#Modeler)
[Modeler API](https://geometry.docs.pyansys.com/version/stable/api/ansys/geometry/core/modeler/Modeler.html)
documentation.

+++
Expand All @@ -61,16 +61,16 @@ Here is how the class architecture is implemented:
* ``Modeler``: Handler object for the active service session. This object allows you
to connect to an existing service by passing in a host and a port. It also
allows you to create ``Design`` objects, which is where the modeling takes
place. For more information, see the [Modeler API](https://geometry.docs.pyansys.com/version/stable/api/ansys/geometry/core/modeler/Modeler.html#Modeler)
place. For more information, see the [Modeler API](https://geometry.docs.pyansys.com/version/stable/api/ansys/geometry/core/modeler/Modeler.html)
documentation.
* ``Design``: Root object of your assembly (tree). While a ``Design`` object is also a
``Component`` object, it has enhanced capabilities, including creating named selections,
adding materials, and handling beam profiles. For more information, see the
[Design API](https://geometry.docs.pyansys.com/version/stable/api/ansys/geometry/core/designer/design/Design.html#Design)
[Design API](https://geometry.docs.pyansys.com/version/stable/api/ansys/geometry/core/designer/design/Design.html)
documentation.
* ``Component``: One of the main objects for modeling purposes. ``Component`` objects
allow you to create bodies, subcomponents, beams, design points, planar surfaces, and more.
For more information, see the [Component API](https://geometry.docs.pyansys.com/version/stable/api/ansys/geometry/core/designer/component/Component.html#Component)
For more information, see the [Component API](https://geometry.docs.pyansys.com/version/stable/api/ansys/geometry/core/designer/component/Component.html)
documentation.

The following code examples show how you use these objects.
Expand Down
12 changes: 12 additions & 0 deletions doc/source/getting_started/compatibility.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,18 @@ and the Ansys product versions.
+---------------------------+------------------------+-------------------------------+-------------------------------+------------------------------+------------------------------+
| ``0.4.X`` | 24R1 onward | :octicon:`check-circle-fill` | :octicon:`check-circle-fill` | :octicon:`check-circle-fill` | :octicon:`check-circle-fill` |
+---------------------------+------------------------+-------------------------------+-------------------------------+------------------------------+------------------------------+
| ``0.5.X`` | 24R1 onward | :octicon:`check-circle-fill` | :octicon:`check-circle-fill` | :octicon:`check-circle-fill` | :octicon:`check-circle-fill` |
+---------------------------+------------------------+-------------------------------+-------------------------------+------------------------------+------------------------------+

.. tip:: Forth- and back-compatibility mechanism

Starting on version ``0.5.X`` and onward, PyAnsys Geometry has implemented a forth- and back-compatibility mechanism to
ensure that the Python library can be used with different versions of the Ansys products.

Methods are now decorated with the ``@min_backend_version`` decorator to indicate the compatibility with the Ansys product versions.
If an unsupported method is called, a ``GeometryRuntimeError`` is raised when attempting to use the method. Users are informed of the
minimum Ansys product version required to use the method.


Access to the documentation for the preceding versions is found at the `Versions <https://geometry.docs.pyansys.com/version/index.html>`_ page.

Expand Down
2 changes: 1 addition & 1 deletion src/ansys/geometry/core/connection/launcher.py
Original file line number Diff line number Diff line change
Expand Up @@ -501,7 +501,7 @@ def launch_modeler_with_discovery(
.. note::
Support for Ansys Discovery is restricted to Ansys 24.1 onwards.
Support for Ansys Discovery is restricted to Ansys 24.1 onward.
When calling this method, a standalone Discovery session is started.
By default, if an endpoint is specified (by defining `host` and `port` parameters)
Expand Down

0 comments on commit 7ca0fc3

Please sign in to comment.