various doc fixes

akaszynski · akaszynski · commit f6f540134df0 · 2020-08-24T23:54:07.000-06:00
diff --git a/pyansys/_version.py b/pyansys/_version.py
@@ -1,5 +1,5 @@
 # major, minor, patch
-version_info = 0, 43, 0
+version_info = 0, 43, 1
 
 # Nice string for the version
 __version__ = '.'.join(map(str, version_info))
diff --git a/pyansys/convert.py b/pyansys/convert.py
@@ -27,22 +27,19 @@ def convert_script(filename_in, filename_out, loglevel='INFO', auto_exit=True,
         Log level of the ansys object within the script.
 
     auto_exit : bool, optional
-        Adds a line to the end of the script to exit ANSYS.  Default True.
+        Adds a line to the end of the script to exit MAPDL.  Default
+        ``True``.
 
     line_ending : str, optional
         When None, automatically determined by OS being used.
-        Acceptable inputs are:
-
-        - \n
-        - \r\n
 
     macros_as_functions : bool, optional
         Attempt to convert macros to python functions.
 
     use_function_names : bool, optional
         Convert MAPDL functions to pyansys.Mapdl class methods.  When
         True "K" will be converted to ``mapdl.k``.  When False, it
-        will be converted to ``mapdl.run('k').
+        will be converted to ``mapdl.run('k')``.
 
     Returns
     -------
@@ -64,7 +61,7 @@ def convert_script(filename_in, filename_out, loglevel='INFO', auto_exit=True,
 
 
 class FileTranslator():
-    obj_name = 'ansys'
+    obj_name = 'mapdl'
     indent = ''
     non_interactive = False
 
@@ -83,7 +80,7 @@ def __init__(self, loglevel='INFO', line_ending=None, exec_file=None,
         self.comment = ''
 
         self.write_header()
-        self.initialize_ansys_object(loglevel, exec_file)
+        self.initialize_mapdl_object(loglevel, exec_file)
 
     def write_header(self):
         hinfo = 'Script generated by pyansys version %s' % pyansys.__version__
@@ -101,16 +98,19 @@ def save(self, filename):
             for line in self.lines:
                 f.write(line)
 
-    def initialize_ansys_object(self, loglevel, exec_file):
+    def initialize_mapdl_object(self, loglevel, exec_file):
         """ Initializes ansys object as lines """
-        self.lines.append('import pyansys%s' % self.line_ending)
+        core_module = 'pyansys'
+        self.lines.append('from %s%s import launch_mapdl' % (core_module,
+                                                             self.line_ending))
         if exec_file:
             exec_file_parameter = '"%s", ' % exec_file
         else:
             exec_file_parameter = ''
-        line = 'ansys = pyansys.launch_mapdl(%sloglevel="%s")%s' % (exec_file_parameter,
-                                                                    loglevel,
-                                                                    self.line_ending)
+        line = '%s = launch_mapdl(%sloglevel="%s")%s' % (self.obj_name,
+                                                         exec_file_parameter,
+                                                         loglevel,
+                                                         self.line_ending)
         self.lines.append(line)
 
     @property
diff --git a/pyansys/launcher.py b/pyansys/launcher.py
@@ -1,5 +1,4 @@
 """Module for launching MAPDL locally."""
-import pathlib
 from glob import glob
 import time
 import subprocess
diff --git a/pyansys/mapdl.py b/pyansys/mapdl.py
@@ -1245,14 +1245,14 @@ def get(self, par="__floatparameter__", entity="", entnum="",
         --------
         Retreive the number of nodes
 
-        >>> value = ansys.get('val', 'node', '', 'count')
+        >>> value = mapdl.get('val', 'node', '', 'count')
         >>> value
         3003
 
         Retreive the number of nodes using keywords.  Note that the
         parameter name is optional.
 
-        >>> value = ansys.get(entity='node', item1='count')
+        >>> value = mapdl.get(entity='node', item1='count')
         >>> value
         3003
 
@@ -1521,6 +1521,11 @@ def modal_analysis(self, method='lanb', nmode='', freqb='', freqe='', cpxmod='',
             Calculate element results, reaction forces, energies, and
             the nodal degree of freedom solution.  Default ``False``.
 
+        Returns
+        -------
+        response : str
+            Output from MAPDL SOLVE command. 
+
         Examples
         --------
         Modal analysis using default parameters for the first 6 modes
@@ -1559,8 +1564,9 @@ def modal_analysis(self, method='lanb', nmode='', freqb='', freqe='', cpxmod='',
         if elcalc:
             self.mxpand(elcalc='YES')
 
-        self.solve()
+        out = self.solve()
         self.finish()
+        return out
 
     def run(self, command, write_to_log=True):
         """Runs APDL command
@@ -1762,6 +1768,15 @@ def get_array(self, entity='', entnum='', item1='', it1num='', item2='',
               ...
               314., 315., 316., 317., 318., 319., 320., 321.])
 
+        List the displacement in the X direction for the first result
+
+        >>> mapdl.post1()
+        >>> mapdl.set(1, 1)
+        >>> disp_x = mapdl.get_array('NODE', item1='U', it1num='X')
+        array([ 0.01605306, -0.01605306,  0.00178402, -0.01605306,
+               ...
+               -0.00178402, -0.01234851,  0.01234851, -0.01234851])
+
         Notes
         -----
         Please reference your ANSYS help manual *VGET command tables
diff --git a/pyansys/parameters.py b/pyansys/parameters.py
@@ -27,7 +27,31 @@
 
 
 class Parameters():
-    """Collection of MAPDL parameters obtainable from the \*GET command"""
+    """Collection of MAPDL parameters obtainable from the \*GET command
+
+    Examples
+    --------
+    Simply list all parameters except for MAPDL MATH parameters
+
+    >>> mapdl.parameters
+    ARR                              : ARRAY DIM (3, 1, 1)
+    PARM_FLOAT                       : 20.0
+    PARM_INT                         : 10.0
+    PARM_LONG_STR                    : "stringstringstringstringstringst"
+    PARM_STR                         : "string"
+    PORT                             : 50052.0
+
+    Get a parameter
+
+    >>> mapdl.parameters['PARM_FLOAT']
+    20.0
+
+    Get an array parameter
+
+    >>> mapdl.parameters['ARR']
+    array([1., 2., 3.])
+
+    """
 
     def __init__(self, mapdl):
         if not isinstance(mapdl, _MapdlCore):
@@ -42,7 +66,7 @@ def _log(self):
         return self._mapdl._log
 
     @property
-    def routine(self):
+    def routine(self) -> str:
         """Current routine string as a string.  For example ``"/PREP7"``
 
         MAPDL Command: \*GET, ACTIVE, 0, ROUT
@@ -52,15 +76,15 @@ def routine(self):
         routine : str
             Routine as a string.  One of:
 
-            - ``"Begin level"``
-            - ``"PREP7"``
-            - ``"SOLUTION"``
-            - ``"POST1"``
-            - ``"POST26"``
-            - ``"AUX2"``
-            - ``"AUX3"``
-            - ``"AUX12"``
-            - ``"AUX15"``
+                - ``"Begin level"``
+                - ``"PREP7"``
+                - ``"SOLUTION"``
+                - ``"POST1"``
+                - ``"POST26"``
+                - ``"AUX2"``
+                - ``"AUX3"``
+                - ``"AUX12"``
+                - ``"AUX15"``
 
         Examples
         --------
@@ -71,78 +95,139 @@ def routine(self):
         return ROUTINE_MAP[int(value)]
 
     @property
-    def units(self):
+    def units(self) -> str:
         """Units specified by /UNITS command.
 
         Returns
         -------
         units : str
-            Active Units.  One of:- "USER"
-            - "SI"
-            - "CGS"
-            - "BFT"
-            - "BIN"
-            - "MKS
-            - "MPA"
-            - "uMKS
+            Active Units.  One of:
+                - ``"None"``
+                - ``"USER"``
+                - ``"SI"``
+                - ``"CGS"``
+                - ``"BFT"``
+                - ``"BIN"``
+                - ``"MKS``
+                - ``"MPA"``
+                - ``"uMKS"``
+
+        Examples
+        --------
+        >>> mapdl.parameters.units
+        'NONE'
         """
         value = self._mapdl.get_value("ACTIVE", item1="UNITS")
         return UNITS_MAP[int(value)]
 
     @property
-    def revision(self):
+    def revision(self) -> float:
         """MAPDL revision version.
 
-        MAPDL revision version as a float.  For example ``20.2``.
+        Examples
+        --------
+        >>> mapdl.parameters.revision
+        20.2
         """
         return float(self._mapdl.get_value("ACTIVE", item1="REV"))
 
     @property
-    def platform(self):
+    def platform(self) -> str:
         """The current platform.
 
-        Current platform.  For example ``"LIN"`` for Linux.
+        Examples
+        --------
+        >>> mapdl.parameters.platform
+        'LIN'
         """
         return self._mapdl.get_value("ACTIVE", item1="PLATFORM")
 
     @property
-    def csys(self):
-        """Active coordinate system"""
+    def csys(self) -> int:
+        """Active coordinate system
+
+        Examples
+        --------
+        >>> mapdl.parameters.csys
+        0
+        """
         return int(self._mapdl.get_value("ACTIVE", item1="CSYS"))
 
     @property
-    def dsys(self):
-        """Active display coordinate system"""
+    def dsys(self) -> int:
+        """Active display coordinate system
+
+        Examples
+        --------
+        >>> mapdl.parameters.dsys
+        0
+        """
         return int(self._mapdl.get_value("ACTIVE", item1="DSYS"))
 
     @property
-    def rsys(self):
-        """Active result coordinate system"""
+    def rsys(self) -> int:
+        """Active result coordinate system
+
+        Examples
+        --------
+        >>> mapdl.parameters.rsys
+        0
+        """
         return int(self._mapdl.get_value("ACTIVE", item1="RSYS"))
 
     @property
-    def esys(self):
-        """Active element coordinate system"""
+    def esys(self) -> int:
+        """Active element coordinate system
+
+        Examples
+        --------
+        >>> mapdl.parameters.esys
+        0
+        """
         return int(self._mapdl.get_value("ACTIVE", item1="ESYS"))
 
     @property
-    def section(self):
-        """Active section number"""
+    def section(self) -> int:
+        """Active section number
+
+        Examples
+        --------
+        >>> mapdl.parameters.section
+        1
+        """
         return int(self._mapdl.get_value("ACTIVE", item1="SECT"))
 
     @property
-    def material(self):
-        """Active material"""
+    def material(self) -> int:
+        """Active material
+
+        Examples
+        --------
+        >>> mapdl.parameters.material
+        1
+        """
         return int(self._mapdl.get_value("ACTIVE", item1="MAT"))
 
     @property
-    def real(self):
-        """Active real constant set"""
+    def real(self) -> int:
+        """Active real constant set
+
+        Examples
+        --------
+        >>> mapdl.parameters.real
+        1
+        """
         return int(self._mapdl.get_value("ACTIVE", item1="REAL"))
 
     @property
-    def type(self):
-        """Active element type"""
+    def type(self) -> int:
+        """Active element type
+
+        Examples
+        --------
+        >>> mapdl.parameters.type
+        1
+        """
         return int(self._mapdl.get_value("ACTIVE", item1="type"))
 
     @property
@@ -198,8 +283,8 @@ def _set_parameter(self, name, value):
         name : str
             An alphanumeric name used to identify this parameter.  Par
             may be up to 32 characters, beginning with a letter and
-            containing only letters, numbers, and underscores.  Examples:
-            ``"ABC" "A3X" "TOP_END"``.
+            containing only letters, numbers, and underscores.
+            Examples: ``"ABC" "A3X" "TOP_END"``.
 
         """
         if not isinstance(value, (str, int, float)):

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`"""Module for launching MAPDL locally."""`
`2`		`-import pathlib`
`3`	`2`	`from glob import glob`
`4`	`3`	`import time`
`5`	`4`	`import subprocess`