GenSynth Documentation

Starting and Providing the License Key

In this step, you will run to start the Docker containers. If you use the optional ---install-templates flag, the script will use the resource-install command to install the available examples from the configured GENSYNTH_PACKAGE_REPO location.

You should run ./ as a regular (non-root) user. If the user does not have permission to start Docker, add them to the Docker user group.

The first time you run this script, you will be prompted for your license key. A license key has 6 groups of 6 hexadecimal digits (letters and numbers), like 012345-6789AB-CDEF01-234567-89ABCD-EF0123.

This script overwrites these files:

  • ./etc/odbc.ini

  • ./etc/gensynth/config.yaml

  • ./etc/gensynth-config/app.config.json

It makes these directories if they do not exist:

  • ./gensynth-internals—This folder hosts these files:

    • ./gensynth-internals/_home_local_share_data_bconf—This is where GenSynth stores its license.

    • ./gensynth-internals/var_lib_gensynth —This is where GenSynth stores its configurations.

    • ./gensynth-internals/pgsql_db_store—This is where GenSynth stores its database.

  • The configured GENSYNTH_WORKSPACE_PATH folder— This is where GenSynth stores logs, input data, and output models.

  • The configured GENSYNTH_PACKAGE_REPO folder—This is normally where you would put packages to be installed.

If you need to change any configuration, stop and start the containers with ./ && ./

Note that stopping the containers will kill all running jobs. At this time, they will not be resumed automatically when you run ./ again.