Skip to main content

Advanced settings

Configuring the tool

You can find different kinds of settings in the configuration file config/settings.yml including: input/output folder settings, settings for when you run the model locally, and CSV settings.

To adjust these settings please create a new file (or copy the settings.yml) and name it local.settings.yml. In this new file you can update any of the settings with your personal ones.

Here is a quick overview of the possible settings and their default values:

SettingWhat does it do?Default value
personal_etm_tokenToken to identify you to the ETM to access your personal scenarios. Learn more..Blank
proxy_serversURLs to the proxy servers you are using. Learn more..Blank
input_file_folderLocation of the main input files, this can be a full path to anywhere on your
input_curves_folderLocation of where the curve files you wish to use are stored, this can be a full path to anywhere on your
output_file_folderLocation of where all output files should be written to by the tools. Again, this can be a full path to any folder on your
local_engine_urlThe url to ETEngine that should be used when you use the local option in the tools.http://localhost:3000/api/v3
local_model_urlThe url to ETModel that should be used when you use the local option in the tools.http://localhost:3001
csv_separatorThe separator your CSV files are using. Some European computers use ';' instead of ','.,

ETM environments

The ETM knows a live and a beta environment. The scenario-tools naturally connect to the first one. In the beta environment experimental features are available for testing, before being included in the live version. This makes the beta version more unstable. You can also run the ETM locally, check the contributors section for more info.

When running any of the scripts in the scenario-tools, you can add the arguments beta or local to create or query scenarios on the ETM beta server or your local machine. The latter assumes your local engine runs at localhost:3000 and local model at localhost:4000, but you can change this in your local.settings.yml at any time. I.e.:

pipenv run scenario_from_csv beta


python local