The Parametric Analysis Tool (PAT) is part of the OpenStudio collection of software tools. It is an electron app.
For more information and documentation on OpenStudio, visit the OpenStudio website or the OpenStudio GitHub repo. User support is available via the community moderated question and answer resource unmethours.com.
If you find a bug, you can help us by submitting an issue. Guidelines for issue submission and prioritization can be found on the OpenStudio wiki.
PAT uses playwright to conduct automated E2E testing. For more information, please see the TESTING.md file.
Install node v18.7.0 and npm v8 if you don't have them already. You can use these commands to check if they are installed. If you don't have them, you can download them with a Node version manager (recommended), an OS-compatible package manager, or a pre-built installer.
Use the following commands to clone the PAT repo and install all dependencies:
git clone https://github.com/NREL/OpenStudio-PAT.git
npm install
npx gulp installDeps
Start the PAT application in develop mode:
npm run start
npm run build
./depend
to the following directory.
./tmp/ParametricAnalysisTool.app/Contents/Resources
./tmp/pat
./tmp/ParametricAnalysisTool.app
./tmp/pat/ParametricAnalysisTool.exe
We tested our Linux-specific instructions on Ubuntu 22.04, but they should also work for other Debian-based distributions.
Install the IDE/compiler for your operating system, if you don't have it already.
sudo apt install g++
Install CMake if you don't have it already. We tested with v3.24.0.
brew install cmake
to install it using homewbrew or download it with the official installersudo apt install cmake
For MacOS / Windows only, install and configure the Qt Installer Framework (QtIFW).
PATH
variable. If you installed a version other than 4.4.1, replace 4.4.1 with the version you installed.
~/.zshrc
or similar (shell-dependent):
export PATH="$HOME/Qt/QtIFW-4.4.1/bin:$PATH"
C:\Qt\Qt-4.4.1\bin
Generate the cmake files.
cd
to the OpenStudio-PAT
project root.cd
into it.
mkdir build
cd build
cmake -DCMAKE_OSX_DEPLOYMENT_TARGET=11 -DCMAKE_OSX_ARCHITECTURES="arm64;x86_64" -DCMAKE_BUILD_TYPE=Release ../
cmake -G "Visual Studio 17 2022" -A x64 ../
QtIFW not found in PATH
warning):
cmake -DCPACK_BINARY_DEB=ON \
-DCPACK_BINARY_IFW=OFF \
-DCPACK_BINARY_TGZ=OFF \
-DCPACK_BINARY_TZ=OFF \
-DCPACK_BINARY_STGZ=OFF \
-DCPACK_BINARY_TBZ2=OFF \
-DCMAKE_BUILD_TYPE=Release \
../
Run the appropriate command to build PAT. The -j
option sets the maximum number of processes to use.
make -j 8 package
cmake --build . --target package -j 8 --config Release
cmake --build . --target package -j 8
The installer package should now be ready to use.
./build/ParametricAnalysisTool-x.x.x-Darwin.dmg
./build/ParametricAnalysisTool-x.x.x-Windows.exe
./build/ParametricAnalysisTool-x.x.x-Linux.deb