(1) Verify prerequisites#

Required access#

Internet access

Specifically, you must have access to Docker Hub and PyPI.

Administrative access

You must have administrative-level access to set firewall rules.

Required Hardware#

Memory

Minimum 16 GB RAM.

Processor

Minimum 4 cores.

Disk Space

Enough disk space to accommodate the number and size of files expected to be transferred by users.

Required software#

Operating systems:

Windows 11 or Windows Server 2022

System Language

English (United States)

Ansys products

Ansys optiSLang 2024 R2 or later

Third-party products#

Python

3.9 to 3.11, with packaging and toml dependencies installed.

The platform automatically uses the Python interpreter included within the Ansys installation. If there is no Python within the Ansys installation, the platform can use an alternative Python interpreter.

WSL 2

Windows Subsystem for Linux (WSL) is a feature of Windows that allows you to run a Linux environment on your Windows machine, without the need for a separate virtual machine or dual booting. It is needed to host the app platform’s services, as they run in Linux containers. More information about WSL here.

To install it, just run the following in administrator mode and restart the machine:

  • PowerShell
wsl --install --no-distribution
Enable-WindowsOptionalFeature -Online -FeatureName "Microsoft-Windows-Subsystem-Linux"

WSL System Resource Allocation: The WSL environment must meet the following recommended requirements:

  • Memory: Minimum 8 GB RAM (Minimum 50% of total RAM of the host machine)

  • Processor: Minimum 4 CPU cores

Follow the steps below to check and update allocated resources to WSL:

  1. Check Current Allocation: Run the following commands inside WSL to verify allocated memory and CPU cores:

    cat /proc/meminfo | grep MemTotal  # Check total allocated memory
    
    nproc  # Check the number of allocated processor cores
    
  2. Update Resource Allocation: If the required specifications are not met, update the .wslconfig file:

    Default location of .wslconfig file: ` C:\Users\<YourUsername>\.wslconfig `

    If the file does not exist, create it. If it exists, update the configuration as needed:

    [wsl2]
    memory=8GB   # Allocates 8GB RAM (modify as needed)
    processors=4  # Allocates 4 CPU cores
    
  3. Apply Changes: To apply the updated configuration, shut down WSL and restart it using the following PowerShell command:

    wsl --shutdown
    

Linux distribution in WSL

The platform needs a Linux distribution to be executed. In order to install it, just run the following in administrator mode:

  • PowerShell
wsl --install -d Ubuntu-22.04

Docker, Docker Compose

2.17.0 or greater

Docker is a platform for developing, shipping, and running applications in isolated containers, and Docker Compose allows you to define and manage multi-container applications with a single configuration file.

To install Docker, follow these steps:

  1. Update the package list.

    sudo apt-get update
    
  2. Install required packages.

    sudo apt-get install ca-certificates curl
    
  3. Create the keyring directory.

    sudo install -m 0755 -d /etc/apt/keyrings
    
  4. Add the Docker GPG key.

    sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
    
  5. Change the keyring file permissions.

    sudo chmod a+r /etc/apt/keyrings/docker.asc
    
  6. Add the Docker repository.

    echo \
        "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] \
        https://download.docker.com/linux/ubuntu \
        $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
        sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
    
  7. Update the package list.

    sudo apt-get update
    
  8. Install Docker packages.

    sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
    
  9. Verify Docker installation.

    sudo docker run hello-world
    
  10. Configure user permissions.

    sudo usermod -aG docker $USER
    
  11. Restart WSL.

    sudo reboot