Merge branch 'main' into doc/examples

jorgepiloto · web-flow · commit cacbecefbf45 · 2024-02-08T10:20:02.000+01:00
diff --git a/pyproject.toml b/pyproject.toml
@@ -77,10 +77,8 @@ select = [
 ]
 ignore = [
 #    "E501",  # Line too long. Ignoring this so "ruff.formatter" manages line length.
-    "D100", # Missing docstring in public module
     "D101", # Missing docstring in public class
     "D102", # Missing docstring in public method
-    "D104", # Missing docstring in public package
     "D105", # Missing docstring in magic method
     "D106", # Missing docstring in public nested class
     "D107", # Missing docstring in `__init__`
diff --git a/src/ansys/stk/core/graphics.py b/src/ansys/stk/core/graphics.py
@@ -2,6 +2,16 @@
 #          Copyright 2020-2023, Ansys Government Initiatives
 ################################################################################ 
 
+"""
+Access and manipulate visual elements in STK.
+
+These include STK globe terrain
+and imagery, camera control, 3D models, triangle meshes, surface polygons and
+polylines, text batches, screen overlays, scene lighting, and raster and
+projection streaming. STK Graphics is available in STK, using UI plugins, as
+well as in STK Engine custom applications.
+"""
+
 __all__ = ["AGICustomTerrainOverlay", "AGICustomTerrainOverlayFactory", "AGIProcessedImageGlobeOverlay", "AGIProcessedImageGlobeOverlayFactory", 
 "AGIProcessedTerrainOverlay", "AGIProcessedTerrainOverlayFactory", "AGIRoamImageGlobeOverlay", "AGIRoamImageGlobeOverlayFactory", 
 "ANTI_ALIASING", "AlphaFromLuminanceFilter", "AlphaFromLuminanceFilterFactory", "AlphaFromPixelFilter", "AlphaFromPixelFilterFactory", 
diff --git a/src/ansys/stk/core/stkdesktop.py b/src/ansys/stk/core/stkdesktop.py
@@ -2,6 +2,8 @@
 #          Copyright 2020-2023, Ansys Government Initiatives
 ################################################################################
 
+"""Starts STK Desktop or attaches to an already running STK Desktop, and provides access to the Object Model root."""
+
 __all__ = ["STKDesktop", "STKDesktopApplication"]
 
 import os
diff --git a/src/ansys/stk/core/stkengine/__init__.py b/src/ansys/stk/core/stkengine/__init__.py
@@ -2,6 +2,8 @@
 #          Copyright 2020-2020, Ansys Government Initiatives
 ################################################################################
 
+"""Starts STK Engine and provides access to the Object Model root."""
+
 __all__ = ["STKEngine", "STKEngineApplication", "STK_ENGINE_TIMER_TYPE"]
 
 import os
diff --git a/src/ansys/stk/core/stkengine/experimental/__init__.py b/src/ansys/stk/core/stkengine/experimental/__init__.py
@@ -0,0 +1 @@
+"""Experimental features."""
diff --git a/src/ansys/stk/core/stkengine/experimental/jupyterwidgets.py b/src/ansys/stk/core/stkengine/experimental/jupyterwidgets.py
@@ -2,6 +2,8 @@
 #          Copyright 2022-2022, Ansys Government Initiatives
 ################################################################################
 
+"""Map and globe widgets for Jupyter Notebooks using Remote Frame Buffer."""
+
 # Dependencies: jupyter_rfb, pillow, imageio, simplejpeg, ipycanvas
 
 __all__ = ['GlobeWidget', 'MapWidget', 'GfxAnalysisWidget']
diff --git a/src/ansys/stk/core/stkengine/tkcontrols.py b/src/ansys/stk/core/stkengine/tkcontrols.py
@@ -2,6 +2,8 @@
 #          Copyright 2021-2021, Ansys Government Initiatives
 ################################################################################
 
+"""Enables Tkinter integration."""
+
 __all__ = ["GlobeControl", "MapControl", "GfxAnalysisControl"]
 
 import os
diff --git a/src/ansys/stk/core/stkobjects/__init__.py b/src/ansys/stk/core/stkobjects/__init__.py
@@ -2,6 +2,8 @@
 #          Copyright 2020-2023, Ansys Government Initiatives
 ################################################################################ 
 
+"""The following is an overview of the classes, interfaces and enumerations of the STK Object Model."""
+
 __all__ = ["ABERRATION_TYPE", "ACCESS_CONSTRAINTS", "ACCESS_TIME_TYPE", "ACTION_TYPE", "ADV_CAT_CONJUNCTION_TYPE", "ADV_CAT_ELLIPSOID_CLASS", 
 "ADV_CAT_SECONDARY_ELLIPSOIDS_VISIBILITY_TYPE", "AIRCRAFT_WGS84_WARNING_TYPE", "ALTITUDE_REFERENCE_TYPE", "ANALYSIS_WORKBENCH_ACCESS_CONSTRAINTS", 
 "ANIMATION_ACTIONS", "ANIMATION_DIRECTIONS", "ANIMATION_MODES", "ANIMATION_OPTIONS", "ANTENNA_CONTOUR_TYPE", "ANTENNA_CONTROL_REFERENCE_TYPE", 
diff --git a/src/ansys/stk/core/stkobjects/astrogator.py b/src/ansys/stk/core/stkobjects/astrogator.py
@@ -2,6 +2,8 @@
 #          Copyright 2020-2023, Ansys Government Initiatives
 ################################################################################ 
 
+"""This library contains Object Model components specifically designed to support STK Astrogator."""
+
 __all__ = ["ACCESS_CRITERION", "ASCENT_TYPE", "ATMOS_DATA_SOURCE", "ATTITUDE_CONTROL", "ATTITUDE_UPDATE", "AccessStoppingCondition", 
 "AsTriggerCondition", "AstrogatorCentralBody", "AttitudeControlFiniteAntiVelocityVector", "AttitudeControlFiniteAttitude", 
 "AttitudeControlFiniteFile", "AttitudeControlFinitePlugin", "AttitudeControlFiniteThrustVector", "AttitudeControlFiniteTimeVarying", 
diff --git a/src/ansys/stk/core/stkobjects/aviator/__init__.py b/src/ansys/stk/core/stkobjects/aviator/__init__.py
@@ -2,6 +2,8 @@
 #          Copyright 2020-2023, Ansys Government Initiatives
 ################################################################################ 
 
+"""This library contains Object Model components specifically designed to support STK Aviator."""
+
 __all__ = ["ACCELERATION_ADVANCED_ACCEL_MODE", "ACCEL_MANEUVER_AERO_PROP_MODE", "ACCEL_MANEUVER_MODE", "ACCEL_MODE", "ACCEL_PERF_MODEL_OVERRIDE", 
 "ADDSMessage", "ADDSMessageCollection", "ADDS_FORECAST_TYPE", "ADDS_MISSING_MSG_TYPE", "ADDS_MSG_EXTRAP_TYPE", "ADDS_MSG_INTERP_TYPE", 
 "ADVANCED_FIXED_WING_AERO_STRATEGY", "ADVANCED_FIXED_WING_GEOMETRY", "ADVANCED_FIXED_WING_POWERPLANT_STRATEGY", "AERO_PROP_FLIGHT_MODE", 
diff --git a/src/ansys/stk/core/stkobjects/aviator/matlab.py b/src/ansys/stk/core/stkobjects/aviator/matlab.py
@@ -2,6 +2,14 @@
 #          Copyright 2020-2023, Ansys Government Initiatives
 ################################################################################ 
 
+"""
+This library contains Object Model components to support the MATLAB strategies found in the Basic Maneuver Procedure.
+
+MATLAB strategies allow the users to
+utilize MATLAB Aerospace Toolbox functions to define the force modeling of the
+aircraft.
+"""
+
 __all__ = ["BasicManeuverMATLABFactory", "IStrategyMATLAB3DGuidance", "IStrategyMATLABFull3D", "IStrategyMATLABNav", "IStrategyMATLABProfile", 
 "StrategyMATLAB3DGuidance", "StrategyMATLABFull3D", "StrategyMATLABNav", "StrategyMATLABProfile"]
 
diff --git a/src/ansys/stk/core/stkruntime.py b/src/ansys/stk/core/stkruntime.py
@@ -2,6 +2,8 @@
 #          Copyright 2023-2023, Analytical Graphics, Inc.
 ################################################################################
 
+"""Starts STK Runtime or attaches to an already running STK Runtime, and provides access to the Object Model root."""
+
 __all__ = ["STKRuntime", "STKRuntimeApplication"]
 
 import atexit
diff --git a/src/ansys/stk/core/stkutil.py b/src/ansys/stk/core/stkutil.py
@@ -2,6 +2,13 @@
 #          Copyright 2020-2023, Ansys Government Initiatives
 ################################################################################ 
 
+"""
+This library contains objects and enumerations shared by the STK X and STK Objects libraries.
+
+The types provided by STK Util are used indirectly through
+methods and properties in the STK X and STK Objects libraries.
+"""
+
 __all__ = ["AZ_EL_ABOUT_BORESIGHT", "COORDINATE_SYSTEM", "CROrientationAzEl", "CROrientationEulerAngles", "CROrientationOffsetCart", 
 "CROrientationQuaternion", "CROrientationYPRAngles", "Cartesian", "Cartesian2Vector", "Cartesian3Vector", "ConversionUtility", 
 "Cylindrical", "DELAUNAY_G_TYPE_TEMP", "DELAUNAY_H_TYPE_TEMP", "DELAUNAY_L_TYPE_TEMP", "DIRECTION_TYPE", "Date", "Direction", 
diff --git a/src/ansys/stk/core/stkx.py b/src/ansys/stk/core/stkx.py
@@ -2,6 +2,41 @@
 #          Copyright 2020-2023, Ansys Government Initiatives
 ################################################################################ 
 
+"""
+STK X allows developers to add advanced STK 2D, 3D visualization and analytical capabilities to applications.
+
+The top of the STK X object model presents the following creatable components:
+
+  * The Application component interfaces to the STK analytical engine. It can be used by itself (in a GUI-less mode), or through the Application property on the Globe and Map controls.   
+The main way to communicate with the engine is to send Connect commands.
+Connect is a language for accessing and manipulating STK (see the
+ExecuteCommand method).  
+The Application object also exposes connection points that you can sink to
+receive notification about the state of the STK engine (for instance a
+scenario has been loaded; an animation step is performed, etc.).  
+Notice that you can instantiate many application objects, but they all refer
+to the same unique STK engine.
+
+  * The Globe control enables you to insert a 3D view into your application.  
+You can use several Globe controls if you wish to have different views of the
+same scenario. By default the STK keyboard and mouse interaction mechanism are
+used, but various events are available, allowing your application to implement
+specific keyboard and mouse interactions and modes.
+
+  * The Map control can be used to insert a 2D view into your application.  
+The Map control gives your application a 2D view of the scenario. You can use
+several Map controls if you wish to have different views of the same scenario.
+By default the STK keyboard and mouse interaction mechanism are used, but
+various events are available, allowing your application to implement specific
+keyboard and mouse interactions and modes.
+
+  * The Graphics Analysis control allows you to insert graphics analysis capability into your application. The Graphics Analysis Control can perform various analyses when set in any of the following four analysis modes. 
+    * Area Tool 
+    * AzElMask Tool 
+    * Obscuration Tool 
+    * Solar Panel Tool
+"""
+
 __all__ = ["BUTTON_VALUES", "DataObject", "DataObjectFiles", "Draw2DElemCollection", "Draw2DElemRect", "DrawElemCollection", 
 "DrawElemLine", "DrawElemRect", "EXEC_MULTI_CMD_RESULT_ACTION", "ExecCmdResult", "ExecMultiCmdResult", "FEATURE_CODES", 
 "GRAPHICS_2D_ANALYSIS_MODE", "GRAPHICS_2D_DRAW_COORDS", "IDataObject", "IDataObjectFiles", "IDrawElem", "IDrawElemCollection", 
diff --git a/src/ansys/stk/core/uiapplication.py b/src/ansys/stk/core/uiapplication.py
@@ -2,6 +2,8 @@
 #          Copyright 2020-2023, Ansys Government Initiatives
 ################################################################################ 
 
+"""The STK UI Application library is a COM library containing classes, interfaces and enumerations for the Application Object Model."""
+
 __all__ = ["APP_CONSTANTS", "APP_ERROR_CODES", "IMRUCollection", "IUiApplication", "IUiApplicationPartnerAccess", "IUiFileOpenExt", 
 "IUiFileOpenExtCollection", "MRUCollection", "OPEN_LOG_FILE_MODE", "UI_LOG_MSG_TYPE", "UiApplication", "UiFileOpenExt", 
 "UiFileOpenExtCollection"]
diff --git a/src/ansys/stk/core/uicore.py b/src/ansys/stk/core/uicore.py
@@ -2,6 +2,8 @@
 #          Copyright 2020-2023, Ansys Government Initiatives
 ################################################################################ 
 
+"""The STK UI Core library is a COM library containing classes, interfaces and enumerations for the Application Object Model."""
+
 __all__ = ["ARRANGE_STYLE", "DOCK_STYLE", "FLOAT_STATE", "IUiToolbar", "IUiToolbarCollection", "IUiWindow", "IUiWindowGlobeObject", 
 "IUiWindowMapObject", "IUiWindowsCollection", "UiToolbar", "UiToolbarCollection", "UiWindow", "UiWindowGlobeObject", "UiWindowMapObject", 
 "UiWindowsCollection", "WINDOW_SERVICE", "WINDOW_STATE"]
diff --git a/src/ansys/stk/core/utilities/__init__.py b/src/ansys/stk/core/utilities/__init__.py
@@ -0,0 +1 @@
+"""Utilities."""
diff --git a/src/ansys/stk/core/vgt.py b/src/ansys/stk/core/vgt.py
@@ -2,6 +2,14 @@
 #          Copyright 2020-2023, Ansys Government Initiatives
 ################################################################################ 
 
+"""
+The Vector Geometry (VGT) API enables users define new or utilize existing geometric constructs such as coordinate systems, vectors, points, angles, axes and planes.
+
+The geometric elements can be used to transform between coordinate
+systems, compute first and second derivatives, or perform other types of
+analysis.
+"""
+
 __all__ = ["AnalysisWorkbenchCentralBody", "AnalysisWorkbenchCentralBodyCollection", "AnalysisWorkbenchCentralBodyRefTo", 
 "AnalysisWorkbenchCollection", "AnalysisWorkbenchConverge", "AnalysisWorkbenchDerivative", "AnalysisWorkbenchGeneric", "AnalysisWorkbenchInstance", 
 "AnalysisWorkbenchIntegral", "AnalysisWorkbenchInterp", "AnalysisWorkbenchLLAPosition", "AnalysisWorkbenchMethodCallAngleFindAngleResult", 
