ANSYS Geometry service NOT INSTALLED

[som1197]

I am trying to install the geometry service for 2024 R2 using the file "build_docker_windows.py" based on the documentation
https://geometry.docs.pyansys.com/version/stable/getting_started/docker/windows_container.html#ref-windows-docker-fromscratch
Firstly, it gave me this error

PS C:\Users\CFD> python build_docker_windows.py
>>> Select the version of Ansys to use:
1: 242
Selection [default - last option]: 1
>>> Using 242
Traceback (most recent call last):
  File "C:\Users\CFD\build_docker_windows.py", line 73, in <module>
    if (ANSYS_VER)> 252:
       ^^^^^^^^^^^^^^^^
TypeError: '>' not supported between instances of 'str' and 'int'  

I fixed it by placing an int() here (on line 73)

if int(ANSYS_VER)> 252:
    print("Select between DMS and Core Services")
    print("1: DMS")
    print("2: Core Services")
    backend_selection = input("Selection [default - 1]: ")
    backend_selection = 1 if backend_selection == "" else int(backend_selection)
    if backend_selection not in [1, 2]:
        print("XXXXXXX Invalid selection XXXXXXX")
        exit(0)
else:
    # Default to DMS for older versions
    backend_selection = 1

After that, I installed the ISO image containing the GeometryService folder since it was not present in the folder structure of ANSYS 2024 R2, based on this issue.
#1374

Now its showing me this error.

PS C:\Users\CFD> python build_docker_windows.py
>>> Select the version of Ansys to use:
1: 242
Selection [default - last option]:
... No selection made, using default
>>> Using 242
>>> Creating temporary directory for building docker image
>>> Copying Geometry Service files to temporary directory to C:\Users\CFD\AppData\Local\Temp\docker_geometry_service_ixlq5093
>>> Zipping temporary directory. This might take some time...
>>> Moving ZIP file to temporary directory
>>> Removing Geometry Service files
>>> Downloading Dockerfile
>>> Updating Dockerfile
>>> Checking if Docker is installed
>>> Building docker image. This might take some time...

ERROR: error during connect: in the default daemon configuration on Windows, the docker client must be run with elevated privileges to connect: Head "http://%2F%2F.%2Fpipe%2Fdocker_engine/_ping": open //./pipe/docker_engine: Access is denied.

[RobPasMue]

Hi @som1197 - thanks for catching the issue with the int! We will definitely submit a fix for that =)

Regarding the issue you are getting right at the end, it seems to be related to your docker installation. I recommend that you restart your machine and try the following commands on your cmd/powershell:

docker ps -a
docker run hello-world

You should see an output similar to this:

PS C:\Users\asdf> docker run hello-world
Unable to find image 'hello-world:latest' locally
latest: Pulling from library/hello-world
e6590344b1a5: Pull complete
Digest: sha256:e0b569a5163a5e6be84e210a2587e7d447e08f87a0e90798363fa44a0464a1e8
Status: Downloaded newer image for hello-world:latest

Hello from Docker!
This message shows that your installation appears to be working correctly.

To generate this message, Docker took the following steps:
 1. The Docker client contacted the Docker daemon.
 2. The Docker daemon pulled the "hello-world" image from the Docker Hub.
    (amd64)
 3. The Docker daemon created a new container from that image which runs the
    executable that produces the output you are currently reading.
 4. The Docker daemon streamed that output to the Docker client, which sent it
    to your terminal.

To try something more ambitious, you can run an Ubuntu container with:
 $ docker run -it ubuntu bash

Share images, automate workflows, and more with a free Docker ID:
 https://hub.docker.com/

For more examples and ideas, visit:
 https://docs.docker.com/get-started/

If that works, that means that your docker install is correct. Also, please share the output of docker info if you can if further assistance is needed,

[RobPasMue]

No I think you are doing everything right honestly... I will have to try and build it myself and see if I also hit the same issues :S

[RobPasMue]

Ah wait! I think I know what might be going on... Can you try running the Python script from an admin terminal?

[som1197]

@RobPasMue , when I run the Python script as an admin it stops at STEP 7 as shown in the error.

C:\Users\~0000AEAdmin>python build_docker_windows.py
>>> Select the version of Ansys to use:
1: 242
Selection [default - last option]: 1
>>> Using 242
>>> Creating temporary directory for building docker image
>>> Copying Geometry Service files to temporary directory to C:\Users\~0000A~1\AppData\Local\Temp\docker_geometry_service_qndygxi1
>>> Zipping temporary directory. This might take some time...
>>> Moving ZIP file to temporary directory
>>> Removing Geometry Service files
>>> Downloading Dockerfile
>>> Updating Dockerfile
>>> Checking if Docker is installed
>>> Building docker image. This might take some time...
Sending build context to Docker daemon  496.3MB
Step 1/16 : FROM mcr.microsoft.com/dotnet/framework/runtime:4.7.2-windowsservercore-ltsc2019
 ---> f7dd39750a4c
Step 2/16 : WORKDIR /temp
 ---> Using cache
 ---> 2d477f2ab25c
Step 3/16 : ADD https://aka.ms/vs/17/release/VC_redist.x64.exe VC_redist.x64.exe

 ---> Using cache
 ---> f04e9ed3b615
Step 4/16 : RUN VC_redist.x64.exe /install /quiet /norestart
 ---> Using cache
 ---> 53228b4d5a60
Step 5/16 : WORKDIR /app
 ---> Using cache
 ---> 13c56cc50573
Step 6/16 : COPY windows-dms-binaries.zip .
 ---> 97ac5f3f90fb
Step 7/16 : RUN mkdir tmp_folder &&     tar -xf windows-dms-binaries.zip -C tmp_folder &&     xcopy tmp_folder\bin\x64\Release_Headless\net472\* . /e /i /h &&     xcopy tmp_folder\* . &&     del windows-dms-binaries.zip &&     rmdir /s /q tmp_folder
 ---> Running in bfb9edbc3dd2
0 File(s) copied
←[91mFile not found - *
←[0m
The command 'cmd /S /C mkdir tmp_folder &&     tar -xf windows-dms-binaries.zip -C tmp_folder &&     xcopy tmp_folder\bin\x64\Release_Headless\net472\* . /e /i /h &&     xcopy tmp_folder\* . &&     del windows-dms-binaries.zip &&     rmdir /s /q tmp_folder' returned a non-zero code: 4

XXXXXXX Docker build failed.. exiting process. XXXXXXX

[RobPasMue]

Okay, at least the build process is working now. This seems to be something I can debug easily on my side (it seems to me that some of the commands in the script might have gone outdated - that's my bad). Let me investigate and get back to you =)

[RobPasMue]

@som1197 - got a fix in #1785, there was definitely some outdated logic in that script... sorry about that. Feel free to give it a try with this new version! I tried it myself and the build process worked :)

[RobPasMue]

After the implementations on #1785 - the various issues raised by @som1197 have been addressed and the script is up to date on the main branch. The Docker image build process now works well.

[RobPasMue]

Hi @som1197 -- I believe this has to do with docker itself rather than PyAnsys Geoemtry and its dependencies. Doing a quick search I did found some issues with incompatibilities between Python packages (requests) and docker (see https://stackoverflow.com/questions/64952238/docker-errors-dockerexception-error-while-fetching-server-api-version). Could you list your current installed dependencies? pip freeze

What I would recommend to clear this out is that you create a new virtual environment and install pyansys-geometry in testing mode:

python -m venv .venv
.\.venv\Scripts\activate #I'm assuming you are on Windows
 python -m pip install --upgrade pip
pip install ansys-geometry-core[tests]

This will install the "tests" environment for PyAnsys Geometry which has more control over the dependencies installed. This is the way we are testing it in our CI/CD (with Docker as well) and we haven't experienced issues as of now.

Nonetheless, please have a look at Environment variables that are required to be defined. The most critical ones (otherwise, you might have problems) are ANSRV_GEO_LICENSE_SERVER, ANSRV_GEO_HOST and ANSRV_GEO_PORT

[som1197]

@RobPasMue : Is there a different way to use this version of the ansys-geometry[tests]? I installed the virtual envirnoment and reran the previous commands but it showed me the same API related error. I also downgraded requests and urlib to a lower version based on the suggestions made in the stack exchange portal.
Docker shows that the instance is running successfully.

I also set the environment variables as mentioned here

SET ANSRV_GEO_LICENSE_SERVER=127.0.0.1
SET ANSRV_GEO_ENABLE_TRACE=0
SET ANSRV_GEO_LOG_LEVEL=2
SET ANSRV_GEO_HOST=127.0.0.1
SET ANSRV_GEO_PORT=50051

The issue lies when I specifically try to launch the Geometry service using the launch_docker_modeler class or when I try to do this manually as shown below. I removed the ans_geo image because it showed that it was already in use, but after that there is another process using it.

C:\Users\~0000AEAdmin>docker ps -a
CONTAINER ID   IMAGE                                   COMMAND                   CREATED         STATUS                             PORTS     NAMES
34fd83f27178   ghcr.io/ansys/geometry:windows-latest   "Presentation.ApiSer…"    8 minutes ago   Created                                      ans_geo
099a5d651a37   ghcr.io/ansys/geometry:windows-latest   "Presentation.ApiSer…"    24 hours ago    Created                                      kind_newton
634593e1f94b   ghcr.io/ansys/geometry:windows-latest   "Presentation.ApiSer…"    24 hours ago    Exited (3221225786) 24 hours ago             nostalgic_jang
bfb9edbc3dd2   97ac5f3f90fb                            "cmd /S /C mkdir tmp…"    2 days ago      Exited (4) 2 days ago                        compassionate_kilby
5c655b96af4a   982038796853                            "cmd /S /C mkdir tmp…"    2 days ago      Exited (4) 2 days ago                        exciting_babbage
1a0c11fa2786   2b4bdde55415                            "cmd /S /C mkdir tmp…"    6 days ago      Exited (4) 6 days ago                        admiring_pasteur
460713258e23   f8d7f14c6181                            "cmd /S /C mkdir tmp…"    9 days ago      Exited (4) 9 days ago                        naughty_nightingale
5a22ac3fed3f   a5fc073fbcf3                            "cmd /S /C mkdir tmp…"    9 days ago      Exited (4) 9 days ago                        mystifying_joliot
d065f4fac122   6e338e0ab8d0                            "cmd /S /C mkdir tmp…"    9 days ago      Exited (4) 9 days ago                        jolly_ellis
7ea447e7143d   095339810f34                            "cmd /S /C mkdir tmp…"    9 days ago      Exited (4294967295) 9 days ago               elegant_neumann
7150f460b951   f4f932fd815d                            "cmd /S /C mkdir tmp…"    9 days ago      Exited (4) 9 days ago                        brave_hoover
cf6179197930   hello-world                             "cmd /C 'type C:\\hel…"   9 days ago      Exited (0) 9 days ago                        cranky_nightingale

C:\Users\~0000AEAdmin>docker rm ans_geo
ans_geo

C:\Users\~0000AEAdmin>docker run --name ans_geo -e LICENSE_SERVER=127.0.0.1 -p 50051:50051 ghcr.io/ansys/geometry:windows-latest
docker: Error response from daemon: failed to create endpoint ans_geo on network nat: failed during hnsCallRawResponse: hnsCall failed in Win32: The process cannot access the file because it is being used by another process. (0x20).

I wanted to check if changing the ANSRV_GEO_PORT to 700 helped. I made those changes by restarting Docker and resetting all environment variables.

SET ANSRV_GEO_LICENSE_SERVER=127.0.0.1
SET ANSRV_GEO_ENABLE_TRACE=0
SET ANSRV_GEO_LOG_LEVEL=2
SET ANSRV_GEO_HOST=127.0.0.1
SET ANSRV_GEO_PORT=700

I followed the same process of listing all the packages and removing ans_geo. Then I got the following output.

C:\Users\~0000AEAdmin>docker run --name ans_geo -e LICENSE_SERVER=127.0.0.1 -p 700:50051 ghcr.io/ansys/geometry:windows-latest
DMS started.
Licensing: Setting ANSYS242_DIR=C:\app\SpaceClaim.DirectModelingService.Internal.dll\ansys
Licensing: Using license server 1055@127.0.0.1
Licensing: License checkout failed
License checkout failed.

gRPC services subscription done.
Server started. Listening on endpoint: 0.0.0.0:50051

This didnt help as the next step which involved connecting to this geometry service ends up running the kernel indefinitely.

from ansys.geometry.core import Modeler
modeler = Modeler()

It returned the following message
---------------------------------------------------------------------------
TimeoutError                              Traceback (most recent call last)
Cell In[7], line 1
----> 1 modeler = Modeler()

File ~\AppData\Roaming\Python\Python312\site-packages\ansys\geometry\core\modeler.py:110, in Modeler.__init__(self, host, port, channel, remote_instance, docker_instance, product_instance, timeout, logging_level, logging_file, backend_type)
    107 """Initialize the ``Modeler`` class."""
    108 from ansys.geometry.core.designer.geometry_commands import GeometryCommands
--> 110 self._grpc_client = GrpcClient(
    111     host=host,
    112     port=port,
    113     channel=channel,
    114     remote_instance=remote_instance,
    115     docker_instance=docker_instance,
    116     product_instance=product_instance,
    117     timeout=timeout,
    118     logging_level=logging_level,
    119     logging_file=logging_file,
    120     backend_type=backend_type,
    121 )
    123 # Maintaining references to all designs within the modeler workspace
    124 self._designs: dict[str, "Design"] = {}

File <@beartype(ansys.geometry.core.connection.client.GrpcClient.__init__) at 0x17940a3b2e0>:236, in __init__(__beartype_get_violation, __beartype_conf, __beartype_object_1620287895360, __beartype_object_1620287895488, __beartype_object_140737016830032, __beartype_object_1619491085776, __beartype_object_1620287896256, __beartype_object_1620287896320, __beartype_object_1620281303632, __beartype_object_1620288011456, __beartype_object_1620287896384, __beartype_func, *args, **kwargs)

File ~\AppData\Roaming\Python\Python312\site-packages\ansys\geometry\core\connection\client.py:191, in GrpcClient.__init__(self, host, port, channel, remote_instance, docker_instance, product_instance, timeout, logging_level, logging_file, backend_type)
    189 # do not finish initialization until channel is healthy
    190 self._grpc_health_timeout = timeout
--> 191 wait_until_healthy(self._channel, self._grpc_health_timeout)
    193 # once connection with the client is established, create a logger
    194 self._log = LOG.add_instance_logger(
    195     name=self._target, client_instance=self, level=logging_level
    196 )

File ~\AppData\Roaming\Python\Python312\site-packages\ansys\geometry\core\connection\client.py:112, in wait_until_healthy(channel, timeout)
    110 else:
    111     target_str = channel._channel.target().decode()
--> 112     raise TimeoutError(
    113         f"Channel health check to target '{target_str}' timed out after {timeout} seconds."
    114     )

TimeoutError: Channel health check to target 'dns:///127.0.0.1:50051' timed out after 120 seconds.

[RobPasMue]

Hi @som1197 - sorry for the late reply. Having a look at:

C:\Users\~0000AEAdmin>docker run --name ans_geo -e LICENSE_SERVER=127.0.0.1 -p 700:50051 ghcr.io/ansys/geometry:windows-latest
DMS started.
Licensing: Setting ANSYS242_DIR=C:\app\SpaceClaim.DirectModelingService.Internal.dll\ansys
Licensing: Using license server 1055@127.0.0.1
Licensing: License checkout failed
License checkout failed.

gRPC services subscription done.

It seems to me that the license checkout is the main problem. And looking at the logs, it did not work properly... are you sure there is a license server running on your machine (i.e. 127.0.0.1) with the port 1055 exposed?

[som1197]

@RobPasMue : Yes the license successfully checks out and the GUI interface opens up when i use this:

from ansys.geometry.core.connection import launch_modeler
modeler = launch_modeler()

But it doesn't work when i use launch_docker_modeler. Is there a way to check if the license was checked out?

[RobPasMue]

Hi @som1197 - you should be able to check if the license checked out inside the container logs. Once you launch the modeler, you should be able to run docker ps -a and find the running container. After that you can run docker logs -f {container-name} to have a look at them.