From 3539a12d73a104294a54ed973c72a3b29465a33d Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 20 Nov 2023 14:49:23 +0000 Subject: [PATCH 1/5] Bump numpy from 1.26.1 to 1.26.2 (#2513) Bumps [numpy](https://github.com/numpy/numpy) from 1.26.1 to 1.26.2. - [Release notes](https://github.com/numpy/numpy/releases) - [Changelog](https://github.com/numpy/numpy/blob/main/doc/RELEASE_WALKTHROUGH.rst) - [Commits](https://github.com/numpy/numpy/compare/v1.26.1...v1.26.2) --- updated-dependencies: - dependency-name: numpy dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- minimum_requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/minimum_requirements.txt b/minimum_requirements.txt index be7a8b7caa..bae8c96518 100644 --- a/minimum_requirements.txt +++ b/minimum_requirements.txt @@ -1,6 +1,6 @@ ansys-api-mapdl==0.5.1 importlib-metadata==6.8.0 -numpy==1.26.1 +numpy==1.26.2 platformdirs==3.11.0 psutil==5.9.6 pyansys-tools-versioning==0.5.0 From 6d36efb384137058c48aa19faad3601f27623674 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 20 Nov 2023 14:49:40 +0000 Subject: [PATCH 2/5] Bump sphinx-reredirects from 0.1.2 to 0.1.3 (#2497) Bumps [sphinx-reredirects](https://github.com/documatt/sphinx-reredirects) from 0.1.2 to 0.1.3. - [Commits](https://github.com/documatt/sphinx-reredirects/compare/v0.1.2...v0.1.3) --- updated-dependencies: - dependency-name: sphinx-reredirects dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 8386027703..36f092723c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -103,7 +103,7 @@ doc = [ "sphinx-gallery==0.14.0", "sphinxcontrib-websupport==1.2.6", "sphinxemoji==0.2.0", - "sphinx-reredirects==0.1.2", + "sphinx-reredirects==0.1.3", "vtk==9.2.6", "sphinx_design==0.5.0", ] From cf5e195f4e86c0b852b6ec61955e2a62eeef3a1b Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 20 Nov 2023 14:50:43 +0000 Subject: [PATCH 3/5] Bump sphinx-autodoc-typehints from 1.24.1 to 1.25.2 (#2512) Bumps [sphinx-autodoc-typehints](https://github.com/tox-dev/sphinx-autodoc-typehints) from 1.24.1 to 1.25.2. - [Release notes](https://github.com/tox-dev/sphinx-autodoc-typehints/releases) - [Changelog](https://github.com/tox-dev/sphinx-autodoc-typehints/blob/main/CHANGELOG.md) - [Commits](https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.24.1...1.25.2) --- updated-dependencies: - dependency-name: sphinx-autodoc-typehints dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 36f092723c..de01f78669 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -98,7 +98,7 @@ doc = [ "pythreejs==2.4.2", "pyvista[trame]==0.42.3", "sphinx-autobuild==2021.3.14", - "sphinx-autodoc-typehints==1.24.1", + "sphinx-autodoc-typehints==1.25.2", "sphinx-copybutton==0.5.2", "sphinx-gallery==0.14.0", "sphinxcontrib-websupport==1.2.6", From 987bf4b628066f71823b35086177c4159359ba8b Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 20 Nov 2023 14:51:51 +0000 Subject: [PATCH 4/5] Bump ansys-mapdl-reader from 0.52.20 to 0.53.0 (#2511) Bumps [ansys-mapdl-reader](https://github.com/pyansys/pymapdl-reader) from 0.52.20 to 0.53.0. - [Release notes](https://github.com/pyansys/pymapdl-reader/releases) - [Commits](https://github.com/pyansys/pymapdl-reader/compare/v0.52.20...v0.53.0) --- updated-dependencies: - dependency-name: ansys-mapdl-reader dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index de01f78669..d4fc064dc2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -81,7 +81,7 @@ tests = [ doc = [ "sphinx==7.2.6", "ansys-dpf-core==0.10.0", - "ansys-mapdl-reader==0.52.20", + "ansys-mapdl-reader==0.53.0", "ansys-sphinx-theme==0.12.4", "grpcio==1.51.1", "imageio-ffmpeg==0.4.9", From e7b8cd1527b80cc011b61aa648124b74f9b50fe9 Mon Sep 17 00:00:00 2001 From: German <28149841+germa89@users.noreply.github.com> Date: Mon, 20 Nov 2023 15:54:56 +0100 Subject: [PATCH 5/5] Reducing README to avoid duplicity (#2490) --- README.rst | 166 ++--------------------------------------------------- 1 file changed, 4 insertions(+), 162 deletions(-) diff --git a/README.rst b/README.rst index 1dbb9c915a..5a5df7d442 100644 --- a/README.rst +++ b/README.rst @@ -34,6 +34,7 @@ PyMAPDL Overview -------- + The PyMAPDL project supports Pythonic access to MAPDL to be able to communicate with the MAPDL process directly from Python. The latest ``ansys-mapdl-core`` package enables a more comprehensive interface with @@ -68,6 +69,9 @@ You can also `view `_ + On the `PyMAPDL Issues `_ page, you can create issues to report bugs and request new features. On the `PyMAPDL Discussions `_ page or the `Discussions `_ @@ -102,168 +106,6 @@ split up into the following projects and modules: For more information on each project, visit their GitHub pages. -Installation ------------- -The ``ansys-mapdl-core`` package currently supports Python 3.8 through -Python 3.11 on Windows, Mac OS, and Linux. - -Install the latest release from `PyPi -`_ with: - -.. code:: console - - pip install ansys-mapdl-core - -If you are planning to use PyMAPDL together with `Jupyter lab `_, -you can install both in one step: - -.. code:: console - - pip install 'ansys-mapdl-core[jupyter]' - - -Alternatively, install the latest from `PyMAPDL GitHub -`_ via: - -.. code:: console - - pip install git+https://github.com/ansys/pymapdl.git - - -For a local "development" version, install with (requires pip >= 22.0): - -.. code:: console - - git clone https://github.com/ansys/pymapdl.git - cd pymapdl - 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 `_ 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.8 and 3.11. You can install -this on an isolated system with a fresh python or on a virtual environment. - -For example, on Linux Ubuntu with Python 3.10, unzip it and install it with the following: - -.. code:: console - - unzip ansys-mapdl-core-v0.65.0-wheelhouse-ubuntu-latest-3.10.zip - wheelhouse - pip install ansys-mapdl-core -f wheelhouse --no-index --upgrade --ignore-installed - -If you're on Windows with Python 3.10, unzip manually to a ``wheelhouse`` directory and -install using the same command as above. - -Consider installing using a `virtual environment -`_. - - -Dependencies ------------- -You must have 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. - - -Getting started ---------------- - -Launch MAPDL locally -~~~~~~~~~~~~~~~~~~~~ -You can launch MAPDL locally directly from Python using ``launch_mapdl``: - -.. code:: python - - from ansys.mapdl.core import launch_mapdl - - mapdl = launch_mapdl() - -This automatically searches for the latest local version of MAPDL, -launches it as a background process, and immediately connects to it. -You can then start sending python commands to MAPDL. - - -Launching manually or connecting to a remote instance -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If you want to connect to a session of MAPDL on a remote computer -(either locally the LAN or through the internet), first ensure you -have MAPDL started in gRPC server mode. This example assumes that you -are launching an instance locally from Windows, but it can be easily -adapted to run from Linux, or the LAN provided the necessary ports are -open. This example specifies the port with ``-port 50052``, but this -option can be left out if you plan on using the default port 50052. - -.. code:: pwsh-session - - start "MAPDL" "%ANSYS211_DIR%\bin\winx64\ANSYS211.exe" -port 50052 -grpc - -Next, connect to the instance of MAPDL from python with: - -.. code:: pycon - - >>> from ansys.mapdl.core import Mapdl - >>> ip = "127.0.0.1" - >>> mapdl = Mapdl(ip=ip, port=50052, start_instance=False) - >>> print(mapdl) - - -A successful connection returns: - -.. code:: output - - Product: ANSYS Mechanical Enterprise - MAPDL Version: RELEASE 2020 R2 BUILD 20.2TEST UPDATE 20200601 - ansys.mapdl.core Version: 0.57.0 - - -Should you want to connect to this instance of MAPDL from a remote -computer, you substitute ``ip=`` with the LAN or WAN address of the -computer you wish to connect to. Depending on your network settings, -you may have to open local ports or enable port redirection across the -WAN. - - -Basic usage -~~~~~~~~~~~ -You run MAPDL commands via: - -.. code:: python - - mapdl.run("/PREP7") - - -Nearly all the built-in MAPDL commands have an associated pythonic -method mapped to it. For example, `/PREP7` is: - -.. code:: python - - mapdl.prep7() - - -There are also non-mapdl commands such as ``mapdl.eplot`` which plot -elements using ``vtk`` and ``pyvista`` rather than relying on MAPDL's -graphics server. Another is ``mapdl.vget``, which leverages gRPC to -rapidly exchange binary arrays from MAPDL to Python rather than -relying on file IO to exchange data. - -Additionally, there are the ``post_processing``, ``geometry``, and -``mesh`` properties, which you can use to perform remote (or local) -post processing without result file exchange, display geometry -properties, or view mesh statistics. Additionally, there's the -``parameters`` property which shows the active MAPDL parameters, and -you can use to send or receive arrays between MAPDL and Python. - -For more information, see the full documentation at `PyMAPDL Documentation -`_. - Citing this module ------------------- If you use ``PyMAPDL`` for research and would like to cite the module