Supported operating systems
eCode is supplied as pre-built binaries with supporting python3 code that enables user customisation. The binaries are built on Ubuntu 20.04.2 LTS and this is the only supported operating system. The user installing the software must have permissions to use sudo on the installation machine.
The installation machine must be connected to the internet when running eCode because the evolve executable must be able to reach the license server.
Prerequisites
Python3 is required and testing of ecode was performed on python 3.10
If not already present it can be installed with:
sudo apt install python3.10
The examples use openai gymnasium mujoco models. If these are not already present, they can be installed with:
sudo apt install python3-pip
sudo pip3 install gymnasium
sudo pip3 install gymnasium[mujoco]
Installation
The eCode software is supplied is a compressed file ecode-XX-YY.tar.gz where XX and YY are replaced by the major and minor version numbers of the release. This file can be downloaded from the My Account page after registration.
Copy the file to a suitable location and extract the contents using:
tar xvf ecode-XX-YY.tar.gz
The resulting eCode directory will contain the following directories:
· bin – this is where the binary executables are located
· examples – this is where the examples are located
· doc – this is where the documentation is located
The binaries should be copied to somewhere in the search path. There is a copy-binaries.sh script in the bin directory that will copy the necessary files into /usr/local/bin. Go into the bin directory and run the script.
cd bin
sh copy-binaries.sh
Licensing
To run eCode the user must obtain a licensee number from the Hyperlect website. This number is displayed on the user’s ‘My Account’ page after registration.
After obtaining the licensee number, enter it into the newly installed instance of ecode using:
evolveLicense <LicenseeNumber>
Note that only the evolve binary is limited by the license. The license will be checked every time evolve runs and this requires the evolve executable to be able to reach the license server over the internet.
The suggested usage and example sections of this user guide show how to use the evolveKill command to terminate evolve. This method ensures that the license is released correctly. If evolve is not terminated in this way, there is a chance that the license will be locked. The maximum period of time that the license will be locked for is 30 minutes.
