Cleanup Docs and Prep for CI (#13)

* change module name to ansys-dpf-post

* docs cleanup

Author: akaszynski

.gitignore

@@ -1,5 +1,3 @@
-
-
 #########################
 ## DPF
 #########################
@@ -20,4 +18,17 @@
 
 #other
 /perso
-/examples/Jupyter lab/.ipynb_checkpoints
+/examples/Jupyter lab/.ipynb_checkpoints
+
+# compiled documentation
+docs/_build
+docs/source/examples
+
+# pip files
+*.egg-info
+build/
+dist/
+
+# emacs temp files
+*~
+.#*

Makefile

@@ -0,0 +1,33 @@
+# Simple makefile to simplify repetitive build env management tasks under posix
+
+CODESPELL_DIRS ?= ./
+CODESPELL_SKIP ?= "*.pyc,*.txt,*.gif,*.png,*.jpg,*.js,*.html,*.doctree,*.ttf,*.woff,*.woff2,*.eot,*.mp4,*.inv,*.pickle,*.ipynb,flycheck*,./.git/*,./.hypothesis/*,*.yml,./docs/_build/*,./docs/images/*,./dist/*,*~,.hypothesis*,./docs/source/examples/*,*cover,*.dat,*.mac,\#*,build,./ansys/dpf/core/raw_operators.py,./run_client.bat,./docker/v211"
+CODESPELL_IGNORE ?= "ignore_words.txt"
+
+all: doctest
+
+doctest: codespell
+
+codespell:
+	@echo "Running codespell"
+	@codespell $(CODESPELL_DIRS) -S $(CODESPELL_SKIP) -I $(CODESPELL_IGNORE)
+
+pydocstyle:
+	@echo "Running pydocstyle"
+	@pydocstyle ansys.mapdl
+
+doctest-modules:
+	@echo "Runnnig module doctesting"
+	pytest -v --doctest-modules ansys.mapdl
+
+coverage:
+	@echo "Running coverage"
+	@pytest -v --cov ansys.mapdl
+
+coverage-xml:
+	@echo "Reporting XML coverage"
+	@pytest -v --cov ansys.mapdl --cov-report xml
+
+coverage-html:
+	@echo "Reporting HTML coverage"
+	@pytest -v --cov ansys.mapdl --cov-report html

ansys/dpf/post/displacement.py

@@ -1,8 +1,8 @@
-"""This module contains the displacement result class ."""
+"""This module contains the displacement result class."""
 
 from ansys.dpf.post.vector import Vector, ComplexVector
 from ansys.dpf.core import locations
-
+from ansys.dpf.post.errors import NodalLocationError
 
 class Displacement(Vector):
     """Defines the displacement object, that is a vector object."""
@@ -11,7 +11,7 @@ def __init__(self, **kwargs):
         self._operator_name = "U"
 
         if self.definition.location != locations.nodal:
-            raise Exception("The location must be nodal.")
+            raise NodalLocationError
 
     def __str__(self):
         txt = super().__str__()
@@ -27,4 +27,4 @@ def __init__(self, **kwargs):
         self._operator_name = "U"
 
         if self.definition.location != locations.nodal:
-            raise Exception("The location must be nodal.")
+            raise NodalLocationError

ansys/dpf/post/dpf_solution.py

@@ -1,9 +1,11 @@
-"""Module containing the DpfSolution class and its childs. 
-Each class highlights an analysis type, and provides hardcoded 
-methods to get a result object regarding the wanted result type.
+"""Module containing the DpfSolution class and its children.  Each class
+highlights an analysis type, and provides hard-coded methods to get a
+result object regarding the wanted result type.
 
-Module containing also the DpfComplexSolution class, child of DpfSolution class.
-Additionnaly to the classic APIs, the complex result introduces an amplitude evaluation."""
+Module containing also the DpfComplexSolution class, child of
+DpfSolution class.  In addition to the classic APIs, the complex
+result introduces an amplitude evaluation.
+"""
 
 
 from ansys.dpf.post.common import _AvailableKeywords
@@ -168,7 +170,7 @@ def __init__(self, data_sources, model):
     def __str__(self):
         txt = super().__str__()
         txt += "\n"
-        txt += "This can contain complex result."
+        txt += "This may contain complex results."
         return txt
 
     def has_complex_result(self):
@@ -276,7 +278,7 @@ def __init__(self, data_sources, model):
     def __str__(self):
         txt = super().__str__()
         txt += "\n"
-        txt += "This can contain complex result."
+        txt += "This may contain complex results."
         return txt
 
     def temperature(self, **kwargs):
@@ -343,4 +345,4 @@ def electric_field(self, **kwargs):
         """
         return ElectricField(data_sources=self._data_sources, model=self._model, **kwargs)
 
-    
+    

ansys/dpf/post/errors.py

@@ -0,0 +1,7 @@
+"""DPF-Post specific errors"""
+
+class NodalLocationError(ValueError):
+    """Raised when attempting to """
+
+    def __init__(self, msg="The location must be nodal."):
+        ValueError.__init__(self, msg)

ansys/dpf/post/examples/__init__.py

@@ -0,0 +1,15 @@
+"""DPF-Post example files"""
+from ansys.dpf.core.examples import (
+    simple_bar,
+    static_rst,
+    complex_rst,
+    multishells_rst,
+    static_rst,
+    electric_therm,
+    steady_therm,
+    transient_therm,
+    download_all_kinds_of_complexity_modal,
+    download_all_kinds_of_complexity,
+    download_transient_result,
+    msup_transient,
+)

ansys/dpf/post/examples/__init__.py~

@@ -0,0 +1,3 @@
+"""DPF-Post example files"""
+
+from ansys.dpf.core.example import *

ansys/dpf/post/examples/__pycache__/__init__.cpython-37.pyc

@@ -1,56 +1,61 @@
-"""Module containing the methode to instantiate the result object. Initialization of post objects."""
+"""Module containing the method to instantiate the result
+object. Initialization of post objects.
+"""
 
-from ansys.dpf.core.model import Model 
+from ansys.dpf.core.model import Model
 
 from ansys.dpf.post.common import _AnalysisType, _AvailableKeywords, _PhysicsType
-from ansys.dpf.post.static_analysis import StaticAnalysisSolution, ThermalStaticAnalysisSolution
+from ansys.dpf.post.static_analysis import (StaticAnalysisSolution,
+                                            ThermalStaticAnalysisSolution)
 from ansys.dpf.post.modal_analysis import ModalAnalysisSolution
 from ansys.dpf.post.harmonic_analysis import HarmonicAnalysisSolution
-from ansys.dpf.post.transient_analysis import TransientAnalysisSolution, ThermalTransientAnalysisSolution
-        
+from ansys.dpf.post.transient_analysis import (TransientAnalysisSolution,
+                                               ThermalTransientAnalysisSolution)
+
 
 def load_solution(data_sources):
-    """Return a Result object which can provide information on a given set, on a given scoping...
-    
+    """Return a ``Result`` object which can provide information on a given
+    set, on a given scoping.
+
     Parameters
     ----------
-    str
-        Can be a filepath to the file you want to open, or a dpf.core.DataSources().
-        
+    data_sources : str or dpf.core.DataSources
+         filepath to the file you want to open, or a dpf.core.DataSources().
+
     Examples
     --------
-    solution = post.solution("file.rst")
+    >>> solution = post.solution("file.rst")
     """
     _model = Model(data_sources)
     data_sources = _model.metadata.data_sources
-    
+
     analysis_type = _model.metadata.result_info.analysis_type
     physics_type = _model.metadata.result_info.physics_type
-    if (physics_type == _PhysicsType.thermal):
-        if(analysis_type == _AnalysisType.static):
-            return ThermalStaticAnalysisSolution(data_sources, _model) 
-        elif (analysis_type == _AnalysisType.transient):
+    if physics_type == _PhysicsType.thermal:
+        if analysis_type == _AnalysisType.static:
+            return ThermalStaticAnalysisSolution(data_sources, _model)
+        elif analysis_type == _AnalysisType.transient:
             return ThermalTransientAnalysisSolution(data_sources, _model)
         else:
-            raise Exception("Unknown analysis type.")
-    elif (physics_type == _PhysicsType.mecanic):
-        if(analysis_type == _AnalysisType.static):
+            raise Exception(f"Unknown analysis type '{analysis_type}' for thermal.")
+    elif physics_type == _PhysicsType.mecanic:
+        if analysis_type == _AnalysisType.static:
             return StaticAnalysisSolution(data_sources, _model)
-        elif (analysis_type == _AnalysisType.modal):
+        elif analysis_type == _AnalysisType.modal:
             return ModalAnalysisSolution(data_sources, _model)
-        elif (analysis_type == _AnalysisType.harmonic):
+        elif analysis_type == _AnalysisType.harmonic:
             return HarmonicAnalysisSolution(data_sources, _model)
-        elif (analysis_type == _AnalysisType.transient):
+        elif analysis_type == _AnalysisType.transient:
             return TransientAnalysisSolution(data_sources, _model)
         else:
-            raise Exception("Unknown analysis type.")
+            raise Exception(f"Unknown analysis type '{analysis_type}' for mechanical.")
     else:
-        raise Exception("Unknown physics type.")
-        
-        
+        raise Exception(f"Unknown physics type '{physics_type}.")
+
+
 def print_available_keywords():
     """Print the keywords that can be used into the result object.
-    
+
     Examples
     --------
     >>> from ansys.dpf import post
@@ -59,4 +64,3 @@ def print_available_keywords():
     """
     txt = _AvailableKeywords().__str__()
     print(txt)
-