User Guide
Version v3.1.6

Before installing Alyvix, first check that your setup meets the system requirements. If it does, you will then need to install Python on your Windows machine before installing Alyvix itself.

## System Requirements¶

Note

Alyvix assumes that you have one virtual or physical machine exclusively dedicated to running Alyvix test cases.

You should check that your designated machine meets the following requirements before you install Alyvix:

Requirements

• Screen color depth: 24-bit RGB or 32-bit RGBA

• OS: Windows 64-bit 10, Server 2012, 2016 or 2019 (32-bit versions of Windows are not compatible with Alyvix)

• Hardware: 2 CPUs and 4GB RAM

## Installing Python¶

1. Download the 64-bit Windows installer for Python version 3.7.9. Note that Alyvix is not compatible with 32-bit versions of Python.

2. Start the installation:

2. Check the box “Add Python 3.7 to PATH” at the bottom

3. Choose the option “Customize installation”

3. On the second panel all the option boxes should already be checked. Click “Next” to continue.

4. On the third panel, make sure the advanced options are set as shown below. Then under “Customize install location”, insert the recommended location C:\Python37\. Finally, click on “Install”. At this point Python will begin installing, typically requiring about 5 minutes.

5. The installation is correct if the following command returns a version number rather than an error message (if not, you will need to edit your Path environment variable):

C:\> python --version
Python 3.7.9


## Installing Alyvix¶

Alyvix itself is installed via pip, the official Python package manager. pip will automatically detect that your system is running Python 3 and will install Alyvix 3, placing all executables in the directory C:\Python37\Lib\site-packages\alyvix\.

The Alyvix installer is launched from the command prompt that, like the Python installer, must be started in Adminstrator mode. Only this single step is required:

1. Run the following command to download and install the latest Alyvix master release along with all of its dependencies:

C:\> pip install alyvix


We recommend you place your Alyvix test cases in a separate data directory.

1. Close Alyvix

• Save all of your currently open projects

• Close all Alyvix user interfaces and applications

• Terminate all running Alyvix processes

• Start a Command Prompt in administrator mode

• Run the following command to download and upgrade to the latest Alyvix master release along with all of its dependencies:

C:\> pip install --upgrade alyvix


## Offline Installation¶

In order to create an offline installation, you will need two machines:

• An internet-connected installer machine with a working Python 3 installation to serve as a source for downloading the required software packages

• A second target machine that will serve as the offline probe

Both machines must meet the second system requirement above, and have access to removable media in order to physically transfer the software from the installer to the target.

The following steps will then enable you to install Alyvix on the target machine:

1. On the installer Windows 64-bit machine with an existing Python 3 installation (not Python 2):

• Create a new directory with appropriate permissions

• Download the 64-bit Windows installer for Python version 3.7.9 to that directory

C:\...\MyFolder> pip download alyvix

2. Copy the entire directory onto the removable media, then copy that directory onto the target machine

3. Use the Python installer now on the target machine to install Python following the instructions above

4. Open a command prompt in the directory on the target machine and install Alyvix with this command:

C:\...\MyFolder> pip install alyvix-3.1.6-cp37-cp37m-win_amd64.whl --no-index --find-links .

5. Check that the installation was successful by starting Alyvix Editor:

C:\> alyvix_editor


If the Editor window appears, the installation was successful.

## Uninstalling Alyvix and Python¶

To uninstall Alyvix, regardless of whether you also want to uninstall Python, run the following command in a Command Prompt or Power Shell with Administrator privileges:

C:\> pip uninstall alyvix


Pip will list the packages to be removed, and then ask for confirmation.

If you only use Python to run Alyvix, you can now also remove Python itself. Go to Start Menu > Windows Settings > Apps, scroll down, and remove both Python 3.7.9 (64-bit) and Python Launcher. The process may take up to 5 minutes.

Once completed, you can also manually remove the C:\Python37\ directory (or whichever directory you specified during installation) and either archive or delete your test case directory.

The Python installer does not remove environment variables, so if desired you can manually remove them at System Properties > Environment Variables > System Variables > Path.

## Installation Troubleshooting¶

Below are some potential installation problems and their solutions.

“Python” command does nothing or launches Microsoft Store on Windows 10

This error occurs when during installation steps #2 and #4 you forgot to check the boxes to add Python to the path and environment variables. Typing the python command in the command prompt under this condition will launch Microsoft Store in an attempt to install it that way.

To correct this situation you will need to either (1) uninstall and then reinstall Python, or (2) manually add the appropriate paths in the System Properties > Environment Variables panel.

“ImportError: DLL load failed” — Failure to Import Tesseract OCR

This error is caused by a missing dependency of the Tesseract OCR module, which requires that the file vcomp140.dll be present in Windows during installation by pip:

File "C:\Python37\lib\site-packages\alyvix\core\tesserocr\__init__.py", line 1, in <module> from ._tesserocr import *
ImportError: DLL load failed: The specified module could not be found.


You can fix this problem by installing the Microsoft Visual C++ Redistributable for Visual Studio, which contains the required file. It’s available at https://aka.ms/vs/16/release/vc_redist.x64.exe .