From fbd3141dd36759b1ef44dc4ddb8197abfcd7f776 Mon Sep 17 00:00:00 2001 From: XXX Date: Thu, 31 Dec 2020 10:19:07 -0700 Subject: [PATCH 1/2] Document environment variables --- .../openstudio_application_interface.md | 30 +++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/markdown_source/docs/reference/openstudio_application_interface.md b/markdown_source/docs/reference/openstudio_application_interface.md index 40fd902..f134005 100644 --- a/markdown_source/docs/reference/openstudio_application_interface.md +++ b/markdown_source/docs/reference/openstudio_application_interface.md @@ -87,7 +87,7 @@ You can use the Multi-edit feature on individual columns (as shown below) or on ------ ## File Menu -If you launch the OpenStudio Application from the SketchUp Plug-in, your open file will automatically open in the application. To save a file or open a new file from within the OpenStudio Application, access the corresponding options within the File menu. +If you launch the OpenStudio Application from the SketchUp Plug-in, your open file will automatically open in the application. To save a file or open a new file from within the OpenStudio Application, access the corresponding options within the File menu. When you save an OpenStudio Model (OSM) in the OpenStudio Application or the SketchUp Plug-in, a folder is saved next to the OSM file. This folder contains external resources such as the weather file, scripts, and simulation results. @@ -104,7 +104,7 @@ The Units menu lets you switch between SI and IP units. This affects both input The SketchUp Plug-in has access to this as well under `Extensions->OpenStudio->Preferences`. -"Change Default Libraries" allows one to restore default libraries. This feature complements the Load Library feature within the File menu. Loading several libraries could increase the duration to boot the OpenStudio Application. To reduce this duration, restore default libraries. +"Change Default Libraries" allows one to restore default libraries. This feature complements the Load Library feature within the File menu. Loading several libraries could increase the duration to boot the OpenStudio Application. To reduce this duration, restore default libraries. [![Preferences Menu](img/os_interface/prefer_menu.png "Click to view")](img/os_interface/prefer_menu.png) @@ -136,3 +136,29 @@ The first time you open this window you will be prompted for an API key, unless [![BCL Window](img/os_interface/bcl_window.png "Click to view")](img/os_interface/bcl_window.png) *Above: This window gives you access to the online BCL to download measures or components.* + +------ + +## Environment Variables + +A variety of environment variables can be used to modify the OpenStudio Applicaton's operation. Environment variables can be set on the command line for a specific session or stored permantently in the advanced system settings on Windows or the ~/.bashrc file on Unix and Mac. + +### OpenStudio Application Environment Variables + +- `OPENSTUDIO_APPLICATION_DEBUG`, if set then debug level logging is enabled +- `OPENSTUDIO_APPLICATION_LOGFILE_PATH`, if set to a path then logging information is sent to the file path +- `OPENSTUDIO_APPLICATION_SLEEP_AT_START`, if set to an integer the application sleeps that many seconds before starting to allow a debugger to attach +- `OPENSTUDIO_APPLICATION_START_TAB_INDEX`, if set to an integer the application opens the specified tab first { SITE = 0, SCHEDULES = 1, CONSTRUCTIONS = 2, LOADS = 3, SPACE_TYPES = 4, GEOMETRY = 5, FACILITY = 6, SPACES = 7, THERMAL_ZONES = 8, HVAC_SYSTEMS = 9, OUTPUT_VARIABLES = 10, SIMULATION_SETTINGS = 11, RUBY_SCRIPTS = 12, RUN_SIMULATION = 13, RESULTS_SUMMARY = 14 } + + +### Qt Environment Variables + +Qt Environment Variables are described in the Qt documentation. + +- `QT_AUTO_SCREEN_SCALE_FACTOR` +- `QT_DEVICE_PIXEL_RATIO` +- `QT_SCALE_FACTOR` +- `QT_SCREEN_SCALE_FACTORS` +- `QTWEBENGINE_CHROMIUM_FLAGS` +- `QTWEBENGINEPROCESS_PATH` +- `QTWEBENGINE_REMOTE_DEBUGGING` \ No newline at end of file From a5f2c96c79b4a4d37d82966df452dc75908467c0 Mon Sep 17 00:00:00 2001 From: Julien Marrec Date: Mon, 4 Jan 2021 10:47:07 +0100 Subject: [PATCH 2/2] Update markdown_source/docs/reference/openstudio_application_interface.md --- .../docs/reference/openstudio_application_interface.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/markdown_source/docs/reference/openstudio_application_interface.md b/markdown_source/docs/reference/openstudio_application_interface.md index f134005..70d50f1 100644 --- a/markdown_source/docs/reference/openstudio_application_interface.md +++ b/markdown_source/docs/reference/openstudio_application_interface.md @@ -141,7 +141,7 @@ The first time you open this window you will be prompted for an API key, unless ## Environment Variables -A variety of environment variables can be used to modify the OpenStudio Applicaton's operation. Environment variables can be set on the command line for a specific session or stored permantently in the advanced system settings on Windows or the ~/.bashrc file on Unix and Mac. +A variety of environment variables can be used to modify the OpenStudio Application's operation. Environment variables can be set on the command line for a specific session or stored permanently in the advanced system settings on Windows or in your profile file (eg `~/.bashrc`) on Unix. ### OpenStudio Application Environment Variables @@ -161,4 +161,4 @@ Qt Environment Variables are described in the Qt documentation. - `QT_SCREEN_SCALE_FACTORS` - `QTWEBENGINE_CHROMIUM_FLAGS` - `QTWEBENGINEPROCESS_PATH` -- `QTWEBENGINE_REMOTE_DEBUGGING` \ No newline at end of file +- `QTWEBENGINE_REMOTE_DEBUGGING`