diff --git a/doc/make.bat b/doc/make.bat index 6f2dec1e0c..90715e7cfb 100644 --- a/doc/make.bat +++ b/doc/make.bat @@ -9,6 +9,7 @@ if "%SPHINXBUILD%" == "" ( ) set SOURCEDIR=source set BUILDDIR=build +set SPHINXOPTS=-n if "%1" == "" goto help if "%1" == "clean" goto clean diff --git a/doc/source/user_guide/custom_operators.rst b/doc/source/user_guide/custom_operators.rst index 9aa1aa21ee..72fb3e9d1c 100644 --- a/doc/source/user_guide/custom_operators.rst +++ b/doc/source/user_guide/custom_operators.rst @@ -249,5 +249,5 @@ Once the plugin is loaded, you can instantiate the custom operator: References ---------- -For more information, see :ref:`ref_custom_operator` in the **API reference** +For more information, see :py:mod:`Custom Operator Base ` in the **API reference** and :ref:`python_operators` in **Examples**. diff --git a/doc/source/user_guide/fields_container.rst b/doc/source/user_guide/fields_container.rst index ec0440f321..bc227cd7eb 100644 --- a/doc/source/user_guide/fields_container.rst +++ b/doc/source/user_guide/fields_container.rst @@ -574,5 +574,5 @@ For comprehensive information on chaining operators, see :ref:`ref_user_guide_op API reference ------------- -For more information, see :ref:`ref_fields_container` and -:ref:`ref_field` in the **API reference**. +For more information, see :py:mod:`FieldsContainer ` and +:py:mod:`Field ` in the **API reference**. diff --git a/doc/source/user_guide/model.rst b/doc/source/user_guide/model.rst index bd3f773a04..b003638835 100644 --- a/doc/source/user_guide/model.rst +++ b/doc/source/user_guide/model.rst @@ -63,7 +63,7 @@ To understand what is available in the result file, you can print the model For a comprehensive model example, see :ref:`ref_basic_example`. -For a description of the ``Model`` object, see :ref:`ref_model`. +For a description of the ``Model`` object, see :py:mod:`Model `. Model metadata @@ -125,7 +125,7 @@ This example shows how you get time sets: [1.] -For a description of the ``Metadata`` object, see :ref:`ref_model`. +For a description of the ``Metadata`` object, see :py:mod:`Model `. Model results ------------- @@ -176,11 +176,11 @@ the mesh scoping: For an example using the ``Result`` object, see :ref:`ref_transient_easy_time_scoping`. -For a description of the ``Model`` object, see :ref:`ref_results`. +For a description of the ``Model`` object, see :py:mod:`Model `. API reference ~~~~~~~~~~~~~ -For more information, see :ref:`ref_model` or :ref:`ref_results`. +For more information, see :py:mod:`Model ` or :py:mod:`Results `. diff --git a/doc/source/user_guide/operators.rst b/doc/source/user_guide/operators.rst index df2c8a647a..f2bd57ecbd 100644 --- a/doc/source/user_guide/operators.rst +++ b/doc/source/user_guide/operators.rst @@ -59,9 +59,9 @@ which is progressively enhanced, see :ref:`ref_dpf_operators_reference`. Create operators ~~~~~~~~~~~~~~~~ -Each operator is of type :ref:`ref_operator`. You can create an instance +Each operator is of type :py:mod:`Operator `. You can create an instance in Python with any of the derived classes available in the -:ref:`ansys.dpf.core.operators package` or directly with the :ref:`ref_operator` +:py:mod:`ansys.dpf.core.operators` package or directly with the :py:mod:`Operator ` class using the internal name string that indicates the operator type. For more information, see :ref:`ref_dpf_operators_reference`. @@ -123,8 +123,8 @@ results, you must provide paths for the result files. You can create data sources in two ways: -- Use the :ref:`ref_model` class. -- Use the :ref:`ref_data_sources` class. +- Use the :py:mod:`Model ` class. +- Use the :py:mod:`Data Sources ` class. Because several other examples use the ``Model`` class, this example uses the @@ -154,7 +154,7 @@ This code demonstrates how to connect the data source to the displacement operat op.inputs.data_sources(data_src) You can connect other optional inputs to the displacement operator. -The output from printing the operator shows that a ``mesh_scoping`` of type :ref:`ref_scoping` +The output from printing the operator shows that a ``mesh_scoping`` of type :py:mod:`Scoping ` can be connected to work on a spatial subset. A ``time_scoping`` of a list of integers can also be connected to work on a temporal subset: @@ -441,5 +441,5 @@ Python client is not on the same machine as the server: API reference ~~~~~~~~~~~~~ For a list of all operators in DPF, see :ref:`ref_dpf_operators_reference` -or the package :ref:`ansys.dpf.core.operators package`. For more information about the -class itself, see :ref:`ref_operator`. +or the package :py:mod:`ansys.dpf.core.operators`. For more information about the +class itself, see :py:mod:`Operator `. diff --git a/src/ansys/dpf/core/helpers/__init__.py b/src/ansys/dpf/core/helpers/__init__.py new file mode 100644 index 0000000000..98edd52744 --- /dev/null +++ b/src/ansys/dpf/core/helpers/__init__.py @@ -0,0 +1,25 @@ +# Copyright (C) 2020 - 2025 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. +"""Provide helpers relating to streamline computation, argument filtering, and text indenting.""" + +from .streamlines import * +from .utils import * diff --git a/src/ansys/dpf/core/model.py b/src/ansys/dpf/core/model.py index acd627c5bf..6b5ef71cb1 100644 --- a/src/ansys/dpf/core/model.py +++ b/src/ansys/dpf/core/model.py @@ -24,7 +24,6 @@ Model. Module contains the Model class to manage file result models. - """ from __future__ import annotations