add wheelhouse

Author: akaszynski

.github/workflows/ci.yml

@@ -16,6 +16,16 @@ env:
   PYANSYS_OFF_SCREEN: True
   DOCKER_PACKAGE: docker.pkg.github.com/pyansys/pymapdl/mapdl
   DOCKER_IMAGE_VERSION_DOCS_BUILD: v21.2.1
+  # Following env vars when changed will "reset" the mentioned cache,
+  # by changing the cache file name. It is rendered as ...-v%RESET_XXX%-...
+  # You should go up in number, if you go down (or repeat a previous value)
+  # you might end up reusing a previous cache if it haven't been deleted already.
+  # It applies 7 days retention policy by default.
+  RESET_PIP_CACHE: 0
+  RESET_EXAMPLES_CACHE: 0
+  RESET_DOC_BUILD_CACHE: 0
+  RESET_AUTOSUMMARY_CACHE: 0
+  PACKAGE_NAME: PyMAPDL
 
 jobs:
 
@@ -68,13 +78,33 @@ jobs:
             Python-${{ runner.os }}-${{ matrix.python-version }}
 
       - name: Install PyMAPDL
-        run: |
-          pip install .
+        run: pip install .
 
       - name: Test import
         working-directory: tests
+        run: python -c "from ansys.mapdl import core as pymapdl; print(pymapdl.Report(gpu=False))"
+
+      - name: Retrieve PyMAPDL version
         run: |
-          python -c "from ansys.mapdl import core as pymapdl; print(pymapdl.Report(gpu=False))"
+          echo "::set-output name=PYMAPDL_VERSION::$(python -c "from ansys.mapdl.core import __version__; print(__version__)")"
+          echo "PyMAPDL version is: $(python -c "from ansys.mapdl.core import __version__; print(__version__)")"
+        id: version
+
+      - name: Generate wheelhouse
+        run: pip wheel . -w wheelhouse
+
+      - name: Zip wheelhouse
+        uses: vimtor/action-zip@v1
+        with:
+          files: wheelhouse
+          dest: ${{ env.PACKAGE_NAME }}-v${{ steps.version.outputs.PYMAPDL_VERSION }}-wheelhouse-${{ runner.os }}-${{ matrix.python-version }}.zip
+
+      - name: Upload Wheelhouse
+        uses: actions/upload-artifact@v2
+        with:
+          name: ${{ env.PACKAGE_NAME }}-v${{ steps.version.outputs.PYMAPDL_VERSION }}-wheelhouse-${{ runner.os }}-${{ matrix.python-version }}
+          path: '*.zip'
+          retention-days: 7
 
   docs_build:
     name: Build Documentation
@@ -306,7 +336,8 @@ jobs:
             ./**/*.whl
             ./**/*.tar.gz
             ./**/*.pdf
-      
+            ./**/*.zip
+
       - name: Notify if fail
         uses: skitionek/notify-microsoft-teams@master
         if: ${{ failure() }}
@@ -316,5 +347,5 @@ jobs:
           job: ${{ toJson(job) }}
           steps: ${{ toJson(steps) }}
           overwrite: "{
-            title: `Release FAILED!`, 
+            title: `Release FAILED!`,
             }"

README.rst

@@ -113,9 +113,34 @@ For a local "development" version, install with:
    pip install -e .
 
 
+Offline Installation
+~~~~~~~~~~~~~~~~~~~~
+If you lack an internet connection on your install machine, the recommended way
+of installing PyMAPDL is downloading the wheelhouse archive from the `Releases
+Page <https://github.com/pyansys/pymapdl/releases>`_ for your corresponding
+machine architecture.
+
+Each wheelhouse archive contains all the python wheels necessary to install
+PyMAPDL from scratch on Windows and Linux for Python 3.7 and 3.9. You can install
+this on an isolated system with a fresh python or on a virtual environment.
+
+For example, on Linux with Python 3.7, unzip it and install it with the following:
+
+.. code::
+
+   unzip PyMAPDL-v0.62.dev1-wheelhouse-Linux-3.7.zip wheelhouse
+   pip install ansys-mapdl-core -f wheelhouse --no-index --upgrade --ignore-installed
+
+If you're on Windows with Python 3.9, unzip to a ``wheelhouse`` directory and
+install using the same command as above.
+
+Consider installing using a `virtual environment
+<https://docs.python.org/3/library/venv.html>`_.
+
+
 Dependencies
 ------------
-You will need a local licenced copy of ANSYS to run MAPDL prior and
+You will need a local licenced copy of Ansys to run MAPDL prior and
 including 2021R1.  If you have the latest version of 2021R1 you do
 not need MAPDL installed locally and can connect to a remote instance
 via gRPC.

doc/source/getting_started/index.rst

@@ -59,50 +59,40 @@ after restarting the Python kernel.
 
 Offline Installation
 ~~~~~~~~~~~~~~~~~~~~
-If you would like to install ``ansys-mapdl-core`` on a computer
-without access to the internet, you can create a ``wheelhouse`` that
-contains all the dependencies necessary to install a python package
-without downloading each package individually.
+If you lack an internet connection on your install machine, the recommended way
+of installing PyMAPDL is downloading the wheelhouse archive from the `Releases
+Page <https://github.com/pyansys/pymapdl/releases>`_ for your corresponding
+machine architecture.
 
-On the host connected to the internet, run:
+Each wheelhouse archive contains all the python wheels necessary to install
+PyMAPDL from scratch on Windows and Linux for Python 3.7 and 3.9. You can install
+this on an isolated system with a fresh python or on a virtual environment.
 
-.. code::
-
-   pip install wheel
-   python -m pip wheel --wheel-dir=pyansys_wheelhouse ansys-mapdl-core
-
-This creates a new directory called ``pyansys_wheelhouse`` which
-contains every python package necessary to install
-``ansys-mapdl-core``.
-
-Next, zip the ``pyansys_wheelhouse`` directory and upload it to your
-offline computer. On the offline computer, unzip it and then install
-it with:
+For example, on Linux with Python 3.7, unzip it and install it with the following:
 
 .. code::
 
-   python -m pip install --no-index --find-links=pyansys_wheelhouse ansys-mapdl-core
-
-This tells Python to install ``ansys-mapdl-core`` by only looking
-within the ``pyansys_wheelhouse`` directory.
+   unzip PyMAPDL-v0.62.dev1-wheelhouse-Linux-3.7.zip wheelhouse
+   pip install ansys-mapdl-core -f wheelhouse --no-index --upgrade --ignore-installed
 
-.. note::
+If you're on Windows with Python 3.9, unzip to a ``wheelhouse`` directory and
+install using the same command as above.
 
-   The OS and version of Python used to generate the wheelhouse must
-   match the offline machine.
+Consider installing using a `virtual environment
+<https://docs.python.org/3/library/venv.html>`_.
 
 
-ANSYS Software Requirements
+Ansys Software Requirements
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
-For the latest features, you will need a copy of ANSYS 2021R1
-installed locally, but PyMAPDL is compatible with ANSYS 17.0 and newer
+For the latest features, you will need a copy of Ansys 2021R1
+installed locally, but PyMAPDL is compatible with Ansys 17.0 and newer
 on Windows and 13.0 on Linux.
 
 .. note::
 
-    The latest versions of ANSYS provide signifiantly better support
+    The latest versions of Ansys provide signifiantly better support
     and features.  Certain features will not be supported by earlier
-    versions of ANSYS (e.g. APDL Math).
+    versions of Ansys (e.g. APDL Math).
 
 
 Verify Your Installation