Merge branch 'main' into release/0.64

Author: germa89

.devcontainer/README.rst

@@ -0,0 +1,106 @@
+
+
+======================
+Develop on a container
+======================
+
+This guide guides you on how to develop PyMAPDL features or fix bugs using
+a `remote container <https://code.visualstudio.com/docs/devcontainers/containers>`_
+or `Codespaces <https://github.com/features/codespaces>`_.
+The files for setting up the container can be found in the 
+`.devcontainer directory <https://github.com/pyansys/pymapdl/tree/main/.devcontainer>`_.
+
+About the MAPDL container
+=========================
+
+Because MAPDL software is not open source, the GPL license does not allow to
+distribute a docker container to users.
+Having a docker container with MAPDL installed is a requirement to use
+any of the development methods mentioned on this section.
+If you want to build your own docker image, visit the following link
+:ref:`ref_make_container`.
+
+
+Develop on a remote container
+=============================
+
+.. note:: If you are an Ansys employee or collaborator and want to use this development method, please email [email protected].
+
+To use a `remote container <https://code.visualstudio.com/docs/devcontainers/containers>`_, you must install:
+
+* `VS Code <https://code.visualstudio.com>`_
+* `Docker software <https://www.docker.com>`_ or equivalent.
+  It is recommended to use Windows Subsystem Linux (WSL) backend to run Linux docker containers.
+  See `Developing inside a Container Getting started <https://code.visualstudio.com/docs/devcontainers/containers#_getting-started>`_
+  for more information.
+* `Remove Development VS Code extension pack <https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack>`_
+
+As mentioned before, you must have your own Docker image with MAPDL installed locally available or hosted in an 
+online registry, i.e. GitHub `ghcr.io <https://github.com/features/packages>`_.
+For the purpose of this document, assume your image is hosted at ``ghcr.io/myaccount/mapdlimage:mytag``.
+
+You must then modify the file `docker-compose.yml <https://github.com/pyansys/pymapdl/tree/main/.devcontainer/docker-compose.yml>`_
+with your custom image:
+
+.. code-block:: yaml
+   :emphasize-lines: 4
+
+   ports:
+      - '50052:50052'
+      - '50055:50055'
+   image: 'ghcr.io/myaccount/mapdlimage:mytag'
+   user: "0:0"
+   volumes:
+
+
+.. warning:: Also you might need to change some environment variables or Docker options to adjust to your image configuration.
+   Be careful to not commit those changes in your PRs.
+
+You can now open the current folder (or PyMAPDL repository) using
+``ctr/cmd`` + ``shift`` + ``p`` to open the VSCode *Command palette*.
+Then select ``Dev Containers: Open Folder in Container``.
+Because the configuration is available in ``.devcontainer`` directory, VS Code will automatically
+launch the MAPDL container with the desired configuration.
+
+You can now work normally, but you will be, in fact, working from inside the container.
+Because VSCode mount the local directory into the docker container, you don't lose your changes if accidentally
+delete your container.
+However, this mounting process might have a significant impact on the container performance, especially noticeable
+if you are using MacOS.
+You can avoid that by cloning the repository inside the container.
+Visit `Quick start: Open a Git repository or GitHub PR in an isolated container volume <https://code.visualstudio.com/docs/devcontainers/containers#_quick-start-open-a-git-repository-or-github-pr-in-an-isolated-container-volume>`_
+for more information.
+
+
+License
+-------
+
+As mentioned before, you must have a valid license to run MAPDL.
+When you launch the container, the file ``script.sh`` automatically checks if the environment
+variable ``ANSYSLMD_LICENSE_FILE`` exists.
+This environment variable sets the port and IP address of the license server.
+
+If you do not have set this environment variable before launching the container, you are prompt to enter
+your license server port and address.
+
+You can set your license using the environment variable ``ANSYSLMD_LICENSE_FILE`` from the terminal before launching
+VS Code. This is recommended if you are using Windows OS.
+For example, if you have a license server at the address ``123.45.67.89``, you can set the license using:
+
+.. code:: pwsh
+  
+   $env:ANSYSLMD_LICENSE_FILE = '[email protected]'
+   code . # launch VS Code
+
+And then open the folder in the container using the *Command palette*.
+
+
+Develop on Codespaces
+=====================
+
+Codespaces is a virtual delopment environment provided by GitHub.
+You can launch a container which all the required tools and start to work in couple of minutes.
+This is an easy way to get started with PyMAPDL development.
+
+.. warning:: This method is only applicable and allowed to Ansys employees or collaborators.
+   If you are an Ansys employee and wants use this development method, please email [email protected].

.devcontainer/devcontainer.json

@@ -3,34 +3,53 @@
 // If you want to run as a non-root user in the container, see .devcontainer/docker-compose.yml.
 {
 	"name": "PyMAPDL Dev Container",
-
 	// Update the 'dockerComposeFile' list if you have more compose files or use different names.
 	// The .devcontainer/docker-compose.yml file contains any overrides you need/want to make.
 	"dockerComposeFile": [
 		"docker-compose.yml"
 	],
-
 	// The 'service' property is the name of the service for the container that VS Code should
 	// use. Update this value and .devcontainer/docker-compose.yml to the real service name.
 	"service": "mapdldev",
-
 	// The optional 'workspaceFolder' property is the path VS Code should open by default when
 	// connected. This is typically a file mount in .devcontainer/docker-compose.yml
-	"workspaceFolder": "/local"
-
+	"workspaceFolder": "/local",
 	// Use 'forwardPorts' to make a list of ports inside the container available locally.
 	// "forwardPorts": [],
-
 	// Uncomment the next line if you want start specific services in your Docker Compose config.
 	// For example the license server service.
 	// "runServices": ["license_server"],
-
 	// Uncomment the next line if you want to keep your containers running after VS Code shuts down.
 	// "shutdownAction": "none",
-
 	// Uncomment the next line to run commands after the container is created - for example installing curl.
-	// "postCreateCommand": "apt-get update && apt install git"
+	"postCreateCommand": "/bin/bash ./.devcontainer/script.sh", //"'pkill -9 -f ansys_inc/v222/ansys'",
 
 	// Uncomment to connect as a non-root user if you've added one. See https://aka.ms/vscode-remote/containers/non-root.
-	// "remoteUser": "vscode"
+	"remoteUser": "root",
+	"updateRemoteUserUID": true,
+	"customizations": {
+		// Configure properties specific to Codespaces.
+		"codespaces": {
+			"openFiles": [
+				".devcontainer/README.rst"
+			]
+		},
+		"vscode": {
+			"extensions": [
+				"hbenl.vscode-test-explorer",
+				"LittleFoxTeam.vscode-python-test-adapter",
+				"ms-azuretools.vscode-docker",
+				"ms-python.python",
+				"ms-vscode-remote.remote-containers",
+				"ms-vscode-remote.remote-ssh-edit",
+				"ms-vscode-remote.remote-ssh",
+				"ms-vscode-remote.remote-wsl",
+				"ms-vscode-remote.vscode-remote-extensionpack",
+				"ms-vscode.remote-explorer",
+				"njpwerner.autodocstring",
+				"VisualStudioExptTeam.vscodeintellicode",
+				"yzhang.markdown-all-in-one",
+			]
+		}
+	}
 }

.devcontainer/docker-compose.yml

@@ -27,13 +27,15 @@ services:
       - ANSYS_LOCK=OFF
       - AWP_ROOT222=/ansys_inc
       - ANSYSLMD_LICENSE_FILE=${ANSYSLMD_LICENSE_FILE}
+      - PYANSYS_OFF_SCREEN=true
     ports:
       - '50052:50052'
       - '50055:50055'
     image: 'ghcr.io/pyansys/mapdl:v22.2-ubuntu'
+    user: "0:0"
     volumes:
       # Update this to wherever you want VS Code to mount the folder of your project
-      - ../:/local
+      - ../:/local:cached
 
     # Uncomment the next line to use Docker from inside the container. See https://aka.ms/vscode-remote/samples/docker-from-docker-compose for details.
     # - /var/run/docker.sock:/var/run/docker.sock 
@@ -45,5 +47,5 @@ services:
     #   - seccomp:unconfined
 
     # Overrides default command so things don't shut down after the process ends.
-    entrypoint: /bin/sh -c "echo 'Container is ready. You can now attach to it.'; while sleep 1000; do :; done"
- 
+    entrypoint: /bin/bash -c "echo 'Container is ready. You can now attach to it.'; while sleep 10000; do :; done"
+

.devcontainer/script.sh

@@ -0,0 +1,27 @@
+#!/bin/bash
+
+echo "Checking if the ANSYSLMD_LICENSE_FILE variable is defined"
+
+if [[ -z "${ANSYSLMD_LICENSE_FILE}" ]]; then
+  echo "ANSYSLMD_LICENSE_FILE is not defined."
+
+  # Read port
+  read -p "Enter port (default is 1055): " port
+  port=${port:-1055}
+
+  # Read license server ip
+  read -p "Enter server (i.e. XXX.XX.XX.XX): " server
+
+  # Set env var for this terminal
+  export ANSYSLMD_LICENSE_FILE="${server}:${port}"
+
+  # Storing env var in .bashrc file so it is automatically loaded.
+  printf "\n%s\n" "ANSYSLMD_LICENSE_FILE=${port}@${server}" >> ~/.bashrc
+
+  # Activating the new configuration
+  source ~/.bashrc
+
+else
+  echo "ANSYSLMD_LICENSE_FILE was found."
+  echo "It is defined as ${ANSYSLMD_LICENSE_FILE}"
+fi

.github/ISSUE_TEMPLATE/documentation.yml

@@ -0,0 +1,31 @@
+name: 📖 Documentation issue
+description: Modifications to the documentation only
+title: "Modify ..."
+labels: ["documentation"]
+assignees: [""]
+
+body:
+
+  - type: markdown
+    attributes:
+      value: '# 📝 **Modifications**'
+
+  - type: textarea
+    id: modifications
+    attributes:
+      label: Description of the modifications
+      placeholder: Describe what modification you propose and why it is useful for the project
+    validations:
+      required: true
+
+  - type: markdown
+    attributes:
+      value: '# 🔗 **References**'
+
+  - type: textarea
+    id: references
+    attributes:
+      label: Useful links and references
+      placeholder: A list of links and references to help when modifying the documentation
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/examples.yml

@@ -0,0 +1,75 @@
+name: 🎓 Adding an example
+description: Proposing a new example for the library
+title: "Example proposal: ..."
+labels: ["example"]
+assignees: [""]
+
+body:
+
+  - type: textarea
+    id: example-description
+    attributes:
+      label: '📝 Description of the example'
+      placeholder: Describe what example you devised and why it is useful for the project.
+
+    validations:
+      required: true
+
+  - type: textarea
+    id: example-files
+    attributes:
+      label: '📁 Files needed for running the example'
+      placeholder: >
+        Drag and drop the files used in your example, together with the script employed.
+        Make sure that it runs on your machine, at the very least.
+        Add any additional comments/explanations that maintainers may need for running the example.
+        If you have issues uploading your files because of the file extension/type, upload them
+        as a .zip file.
+    validations:
+      required: true
+
+  - type: dropdown
+    id: os-name
+    attributes:
+      label: '💻 Which operating system are you using?'
+      multiple: false
+      options:
+       - 'Windows'
+       - 'MacOS'
+       - 'Linux'
+    validations:
+      required: true
+
+  - type: textarea
+    id: ansys-version
+    attributes:
+      label: '📀 Which ANSYS version are you using?'
+      placeholder: Indicate the ANSYS version of the products you are using.
+
+    validations:
+      required: false
+
+  - type: dropdown
+    id: python-version
+    attributes:
+      label: '🐍 Which Python version are you using?'
+      description: Run `python --version` to verify your Python version
+      multiple: false
+      options:
+       - '3.7'
+       - '3.8'
+       - '3.9'
+       - '3.10'
+       - '3.11'
+    validations:
+      required: true
+
+  - type: textarea
+    id: installed-packages
+    attributes:
+      label: '📦 Installed packages'
+      description: Run `python -m pip freeze` to list installed packages
+      placeholder: Paste the output of `python -m pip freeze` here.
+      render: shell
+    validations:
+      required: true

.github/dependabot.yml

@@ -1,5 +1,19 @@
 version: 2
 updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    insecure-external-code-execution: allow
+    schedule:
+      interval: "weekly"      
+      day: "friday"
+      time: "00:00"
+
+    labels:
+      - "Maintenance"
+      - "Dependencies"
+    ignore:
+      - dependency-name: "grpcio"
+      - dependency-name: "sphinx"
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule: