Initializing help system before first use

Customizing the Default Environment

You can use the default example environment as a starting point for configuring your own customized environment.
Make sure that you are deploying using one of the configurations that includes Conda:
  • insight-local-conda-filesystem
  • insight-local-conda-mysql
The default Conda environment is a minimal example that installs the packages that are required for running the Python Quick Start example for Xpress Insight. This environment is named example-environment and is loaded by default when the worker container starts.

If you need only a single environment, the simplest approach is to customize this example environment for your needs. (Alternatively, you can copy it to a new subdirectory and use it as a starting point for creating a new environment; for more information, see Configuring Additional Environments.)

To customize the default environment, follow these steps:

  1. From the root directory for the configuration you are using, navigate to the environments subdirectory.
  2. Edit the environment.yml file.
    You can update the name scalar to specify a meaningful name for your environment, and make any other changes (such as adding or removing channels and packages). For more information about editing environment.yml, see the Conda documentation.
  3. If you changed the environment name, edit the .env file in the root directory for the configuration you are using.
    Change the value of the MINICONDA_ENV environment variable to match the new environment name. This environment variable specifies which environment is to be loaded by default when the worker container starts.
  4. (Optional) If you need to specify any additional application properties for the default environment, add them to the worker-config/override.properties file in the following format:
    insight.worker.execution.environment.PROPERTY=value
    Note: These properties will apply to all execution environments. If you plan to use additional custom environments, you might need to override or unset some properties. For more information, see Configuring Additional Environments.
  5. Stop and restart the worker container using docker compose down and docker compose up (or Docker Desktop).

© 2001-2025 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.