Add basic example files to module (#20)

* add additional examples

* update model test

* add plot contour testing

* patch component count

* move cache

* fix temp file creation and deletion

* add ignored word due to entrie(s)

* add docker directory mapping for downloads cache

* add docstring for example downloads

* fix paths in examples

* add typehint

* patch single component plotting

Author: akaszynski

.ci/azure-pipelines.yml

@@ -128,7 +128,7 @@ jobs:
         set -ex
         echo $(PAT) | docker login -u $(GH_USERNAME) --password-stdin docker.pkg.github.com
         docker pull $(DPF_IMAGE)
-        docker run --restart always --name dpf -v `pwd`:/dpf -p $(DPF_PORT):50054 $(DPF_IMAGE) > log.txt &
+        docker run --restart always --name dpf -v `pwd`:/dpf -v /tmp:/dpf/_cache -p $(DPF_PORT):50054 $(DPF_IMAGE) > log.txt &
         grep -q 'server started on ip' <(timeout 60 tail -f log.txt)
         python -c "from ansys.dpf import core; core.connect_to_server(port=$(DPF_PORT)); print('Python Connected')"
       displayName: Pull, launch, and validate DPF service

.github/workflows/ci-build.yml

@@ -44,7 +44,7 @@ jobs:
       - name: Pull, launch, and validate DPF service
         run: |
           echo $PAT | docker login -u $GH_USERNAME --password-stdin docker.pkg.github.com
-          docker run --restart always --name dpf -v `pwd`:/dpf -p $DPF_PORT:50054 $DPF_IMAGE > log.txt &
+          docker run --restart always --name dpf -v `pwd`:/dpf -v /tmp:/dpf/_cache -p $DPF_PORT:50054 $DPF_IMAGE > log.txt &
           grep -q 'server started on ip' <(timeout 60 tail -f log.txt)
           python -c "import os; from ansys.dpf import core; core.connect_to_server(port=os.environ['DPF_PORT']); print('Python Connected')"
         env:

ansys/dpf/core/__init__.py

@@ -40,11 +40,10 @@
 if os.environ.get('DPF_DOCKER', False):  # pragma: no cover
     # Running DPF within docker (likely for CI)
     # path must be relative to DPF directory
-    _module_path = os.path.dirname(inspect.getfile(inspect.currentframe()))
-    EXAMPLES_PATH = os.path.join(_module_path, 'examples', '_cache')
-    if not os.path.isdir(EXAMPLES_PATH):
-        os.makedirs(EXAMPLES_PATH)
-
+    #
+    # assumes the following docker mount:
+    # -v /tmp:/dpf/_cache
+    EXAMPLES_PATH = '/tmp'
 else:
     try:
         import appdirs

ansys/dpf/core/_version.py

@@ -1,6 +1,6 @@
 """Version for ansys-dpf-core"""
 # major, minor, patch
-version_info = 0, 1, 2
+version_info = 0, 2, 0
 
 # Nice string for the version
 __version__ = '.'.join(map(str, version_info))

ansys/dpf/core/collection.py

@@ -210,7 +210,7 @@ def __getitem__(self, index):
         if not self_len:
             raise IndexError('This collection contains no items')
         if index >= self_len:
-            raise IndexError(f'This collection contains only {self_len} entries')
+            raise IndexError(f'This collection contains only {self_len} entrie(s)')
 
         return self._get_entries(index)
 

tests/testfiles/complex/fileComplex.rst renamed to ansys/dpf/core/examples/complex.rst

@@ -23,7 +23,7 @@ def _retrieve_file(url, filename, directory):
     local_path = os.path.join(EXAMPLES_PATH, directory, os.path.basename(filename))
     local_path_no_zip = local_path.replace('.zip', '')
     if os.path.isfile(local_path_no_zip) or os.path.isdir(local_path_no_zip):
-        return local_path_no_zip, None
+        return local_path_no_zip
 
     # grab the correct url retriever
     urlretrieve = urllib.request.urlretrieve
@@ -44,13 +44,84 @@ def _download_file(directory, filename):
     if os.environ.get('DPF_DOCKER', False):  # pragma: no cover
         # override path if running on docker as path must be relative
         # to docker mount
-        local_path = os.path.join('/dpf/ansys/dpf/core/examples/_cache/', directory,
-                                  filename)
+        #
+        # Assumes the following mapping in docker
+        # DWN_CSH=/tmp/dpf_cache
+        # -v $DWN_CSH:/dpf/_cache
+        local_path = os.path.join('/dpf/_cache', directory, filename)
     return local_path
 
 ###############################################################################
 # front-facing downloads
 
-def download_transient_result():
-    """Download an example transient result and return the download path"""
+def download_transient_result() -> str:
+    """Download an example transient result file and return the download path.
+
+    Examples files are downloaded to a persistent cache to avoid
+    re-downloading the same file twice.
+
+    Returns
+    -------
+    str
+        Path to the example file.
+
+    Examples
+    --------
+    Download an example result file and return the path of the file
+
+    >>> from ansys.dpf.core import examples
+    >>> path = examples.transient_result
+    >>> path
+    'C:/Users/user/AppData/local/temp/transient.rst'
+
+    """
     return _download_file('transient', 'transient.rst')
+
+
+def download_all_kinds_of_complexity() -> str:
+    """Download an example static result and return the download path.
+
+    Examples files are downloaded to a persistent cache to avoid
+    re-downloading the same file twice.
+
+    Returns
+    -------
+    str
+        Path to the example file.
+
+    Examples
+    --------
+    Download an example result file and return the path of the file
+
+    >>> from ansys.dpf.core import examples
+    >>> path = examples.download_all_kinds_of_complexity
+    >>> path
+    'C:/Users/user/AppData/local/temp/allKindOfComplexity.rst'
+
+    """
+    return _download_file('testing', 'allKindOfComplexity.rst')
+
+
+def download_all_kinds_of_complexity_modal() -> str:
+    """Download an example result file from a static modal analsys and
+    return the download path.
+
+    Examples files are downloaded to a persistent cache to avoid
+    re-downloading the same file twice.
+
+    Returns
+    -------
+    str
+        Path to the example file.
+
+    Examples
+    --------
+    Download an example result file and return the path of the file
+
+    >>> from ansys.dpf.core import examples
+    >>> path = examples.download_all_kinds_of_complexity_modal
+    >>> path
+    'C:/Users/user/AppData/local/temp/modal_allKindOfComplexity.rst'
+
+    """
+    return _download_file('testing', 'modal_allKindOfComplexity.rst')

ansys/dpf/core/examples/downloads.py

@@ -11,3 +11,9 @@
 # this files can be imported with from `ansys.dpf.core import examples`:
 simple_bar = os.path.join(_module_path, 'ASimpleBar.rst')
 static_rst = os.path.join(_module_path, 'static.rst')
+complex_rst = os.path.join(_module_path, 'complex.rst')
+multishells_rst = os.path.join(_module_path, 'model_with_ns.rst')
+electric_therm = os.path.join(_module_path, 'rth', 'rth_electric.rth')
+steady_therm = os.path.join(_module_path, 'rth', 'rth_steady.rth')
+transient_therm = os.path.join(_module_path, 'rth', 'rth_transient.rth')
+msup_transient = os.path.join(_module_path, 'msup_transient_plate1.rst')