Writing new Optimizees

To create a new Optimizee, the currently recommended method is the following:

1. Create an entirely separate repository for your Optimizee code (preferably under the IGITUGraz Github organization).
2. Install the LTL package on your system following instructions below.
3. Write your Optimizee using the LTL Optimizee interface as described in the documentation.
4. Write your experiment using the Optimizers in LTL and their interfaces as described in the documentation.

If you're writing a new Optimizee and only want to use the Optimizers in the LTL package (and not modify them) you don't have to commit any changes into the LTL package.

To Install The LTL Package

From the Top-Level directory of the directory, run the following command:

python3 setup.py develop [--user]

The --user flag is to be used if you wish to install in the user path as opposed to the root path (e.g. when one does not have sudo access)

The above will install the package by creating symlinks to the code files in the relevant directory containing python modules. This means that you can change any of the code files and see the changes reflected in the package immediately (i.e. without requiring a reinstall). In order to uninstall one may run the following:

python3 setup.py develop --uninstall

Note that if the setup was done using sudo access, then the uninstall must also be done using sudo access

Having installed this package, we now have access to the top level ltl module which contains all the relevant modules relevant for using the ltl package.