From 3122942e5addb0cd776f1a3c5eeba084cf8e952b Mon Sep 17 00:00:00 2001 From: Brian Ball Date: Mon, 23 Oct 2023 17:48:41 -0400 Subject: [PATCH 01/18] 3.7.0-rc1 --- Dockerfile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Dockerfile b/Dockerfile index 222f8c925..d41f7dd03 100644 --- a/Dockerfile +++ b/Dockerfile @@ -4,8 +4,8 @@ # NOTES: Currently this is one big dockerfile and non-optimal. #may include suffix -ARG OPENSTUDIO_VERSION=3.6.1 -FROM nrel/openstudio:3.6.1 as base +ARG OPENSTUDIO_VERSION=3.7.0-rc1 +FROM nrel/openstudio:3.7.0-rc1 as base MAINTAINER Nicholas Long nicholas.long@nrel.gov ENV DEBIAN_FRONTEND=noninteractive From 07bc1535be2a0183bfb57dd13e7fc2a14be24326 Mon Sep 17 00:00:00 2001 From: Brian Ball Date: Mon, 23 Oct 2023 18:01:32 -0400 Subject: [PATCH 02/18] 3.7.0-rc1 --- appveyor.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/appveyor.yml b/appveyor.yml index 17aaa03af..916025add 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -4,8 +4,8 @@ image: Visual Studio 2019 environment: USE_TESTING_TIMEOUTS: "true" - OPENSTUDIO_VERSION: 3.6.1 - OPENSTUDIO_VERSION_SHA: bb9481519e + OPENSTUDIO_VERSION: 3.7.0-rc1 + OPENSTUDIO_VERSION_SHA: 211bb633b0 OPENSTUDIO_VERSION_EXT: "" OPENSTUDIO_TEST_EXE: C:\projects\openstudio\bin\openstudio.exe BUILD_TYPE: "test" From ec42f19fe8c37ed762bdefd7083a0f4144fe756d Mon Sep 17 00:00:00 2001 From: Brian Ball Date: Mon, 23 Oct 2023 18:02:31 -0400 Subject: [PATCH 03/18] Update appveyor.yml --- appveyor.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/appveyor.yml b/appveyor.yml index 916025add..61896cd52 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -4,9 +4,9 @@ image: Visual Studio 2019 environment: USE_TESTING_TIMEOUTS: "true" - OPENSTUDIO_VERSION: 3.7.0-rc1 + OPENSTUDIO_VERSION: 3.7.0 OPENSTUDIO_VERSION_SHA: 211bb633b0 - OPENSTUDIO_VERSION_EXT: "" + OPENSTUDIO_VERSION_EXT: "-rc1" OPENSTUDIO_TEST_EXE: C:\projects\openstudio\bin\openstudio.exe BUILD_TYPE: "test" SKIP_COVERALLS: "true" From 2cb2a4d4ee4b5b3d7df38cc87c634172a1a86cf5 Mon Sep 17 00:00:00 2001 From: Brian Ball Date: Mon, 23 Oct 2023 18:08:35 -0400 Subject: [PATCH 04/18] Update openstudio-server-tests.yml --- .github/workflows/openstudio-server-tests.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/openstudio-server-tests.yml b/.github/workflows/openstudio-server-tests.yml index 9bea5d26e..3b15e356f 100644 --- a/.github/workflows/openstudio-server-tests.yml +++ b/.github/workflows/openstudio-server-tests.yml @@ -10,9 +10,9 @@ on: [push, pull_request] env: USE_TESTING_TIMEOUTS: "true" - OPENSTUDIO_VERSION: 3.6.1 - OPENSTUDIO_VERSION_SHA: bb9481519e - OPENSTUDIO_VERSION_EXT: "" + OPENSTUDIO_VERSION: 3.7.0 + OPENSTUDIO_VERSION_SHA: 211bb633b0 + OPENSTUDIO_VERSION_EXT: "-rc1" DOCKER_COMPOSE_VERSION: 1.21.1 BUNDLE_WITHOUT: native_ext @@ -97,7 +97,7 @@ jobs: - name: docker shell: bash run: | - export OPENSTUDIO_TAG=3.6.1 + export OPENSTUDIO_TAG=3.7.0-rc1 sed -i -E "s/.git//g" .dockerignore docker volume create --name=osdata docker images --all From fd5463329bc4ca1e0056afb274e155db3094ae77 Mon Sep 17 00:00:00 2001 From: Brian Ball Date: Mon, 23 Oct 2023 18:09:45 -0400 Subject: [PATCH 05/18] Update security-scan.yml --- .github/workflows/security-scan.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/security-scan.yml b/.github/workflows/security-scan.yml index 3180f0d08..9d2358f53 100644 --- a/.github/workflows/security-scan.yml +++ b/.github/workflows/security-scan.yml @@ -10,9 +10,9 @@ on: [push, pull_request] env: USE_TESTING_TIMEOUTS: "true" - OPENSTUDIO_VERSION: 3.6.1 - OPENSTUDIO_VERSION_SHA: bb9481519e - OPENSTUDIO_VERSION_EXT: "" + OPENSTUDIO_VERSION: 3.7.0 + OPENSTUDIO_VERSION_SHA: 211bb633b0 + OPENSTUDIO_VERSION_EXT: "-rc1" DOCKER_COMPOSE_VERSION: 1.21.1 BUNDLE_WITHOUT: native_ext @@ -31,7 +31,7 @@ jobs: - name: docker shell: bash run: | - export OPENSTUDIO_TAG=3.6.1 + export OPENSTUDIO_TAG=3.7.0-rc1 sed -i -E "s/.git//g" .dockerignore docker volume create --name=osdata docker images --all From 42613df1684d4528df420a2f6c9682c9d4d7d8e0 Mon Sep 17 00:00:00 2001 From: Brian Ball Date: Mon, 23 Oct 2023 18:10:50 -0400 Subject: [PATCH 06/18] Update setup.cmd --- ci/appveyor/setup.cmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ci/appveyor/setup.cmd b/ci/appveyor/setup.cmd index 89b84f537..556bc66a0 100644 --- a/ci/appveyor/setup.cmd +++ b/ci/appveyor/setup.cmd @@ -10,7 +10,7 @@ set OS_INSTALL_NAME=OpenStudio-%OPENSTUDIO_VERSION%%OPENSTUDIO_VERSION_EXT%%%2B% echo Install name is %OS_INSTALL_NAME% REM curl -SLO --insecure https://openstudio-ci-builds.s3-us-west-2.amazonaws.com/develop/%OS_INSTALL_NAME% -curl -SLO --insecure https://github.com/NREL/OpenStudio/releases/download/v3.6.1/%OS_INSTALL_NAME% +curl -SLO --insecure https://github.com/NREL/OpenStudio/releases/download/v3.7.0-rc1/%OS_INSTALL_NAME% dir . REM Install OpenStudio %OS_INSTALL_NAME% --script ci/appveyor/install-windows.qs From 45358eb205d22e4fa7919ec3e560046aa6a02ab8 Mon Sep 17 00:00:00 2001 From: Brian Ball Date: Mon, 23 Oct 2023 18:11:29 -0400 Subject: [PATCH 07/18] Update install_openstudio.sh --- ci/github-actions/install_openstudio.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ci/github-actions/install_openstudio.sh b/ci/github-actions/install_openstudio.sh index 91fc70003..3a152eef3 100755 --- a/ci/github-actions/install_openstudio.sh +++ b/ci/github-actions/install_openstudio.sh @@ -11,7 +11,7 @@ if [ ! -z ${OPENSTUDIO_VERSION} ] && [ ! -z ${OPENSTUDIO_SHA} ]; then OPENSTUDIO_DOWNLOAD_FILENAME=OpenStudio-${OPENSTUDIO_VERSION}${OPENSTUDIO_VERSION_EXT}%2B${OPENSTUDIO_SHA}-Ubuntu-20.04-x86_64.deb echo "Installing OpenStudio ${OPENSTUDIO_DOWNLOAD_FILENAME}" #OPENSTUDIO_DOWNLOAD_BASE_URL=https://openstudio-ci-builds.s3-us-west-2.amazonaws.com/develop - OPENSTUDIO_DOWNLOAD_BASE_URL=https://github.com/NREL/OpenStudio/releases/download/v3.6.1 + OPENSTUDIO_DOWNLOAD_BASE_URL=https://github.com/NREL/OpenStudio/releases/download/v3.7.0-rc1 OPENSTUDIO_DOWNLOAD_URL=$OPENSTUDIO_DOWNLOAD_BASE_URL/$OPENSTUDIO_DOWNLOAD_FILENAME # copying this from the docker-openstudio dockerfile From 933763a3f51002ae0a1b5194bd4124fffff582d9 Mon Sep 17 00:00:00 2001 From: Brian Ball Date: Mon, 23 Oct 2023 18:12:43 -0400 Subject: [PATCH 08/18] Update setup.sh --- ci/github-actions/setup.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ci/github-actions/setup.sh b/ci/github-actions/setup.sh index 114c5e3c2..adb6fefbd 100755 --- a/ci/github-actions/setup.sh +++ b/ci/github-actions/setup.sh @@ -37,7 +37,7 @@ else export OS_NAME=OpenStudio-${OPENSTUDIO_VERSION}${OPENSTUDIO_VERSION_EXT}%2B${OPENSTUDIO_VERSION_SHA}-Darwin-x86_64 export OS_NAME_WITH_PLUS=OpenStudio-${OPENSTUDIO_VERSION}${OPENSTUDIO_VERSION_EXT}+${OPENSTUDIO_VERSION_SHA}-Darwin-x86_64 #curl -SL --insecure https://openstudio-ci-builds.s3-us-west-2.amazonaws.com/develop/${OS_NAME}.tar.gz -o $OS_NAME_WITH_PLUS.tar.gz - curl -SL --insecure https://github.com/NREL/OpenStudio/releases/download/v3.6.1/${OS_NAME}.tar.gz -o $OS_NAME_WITH_PLUS.tar.gz + curl -SL --insecure https://github.com/NREL/OpenStudio/releases/download/v3.7.0-rc1/${OS_NAME}.tar.gz -o $OS_NAME_WITH_PLUS.tar.gz # OSX downloads with %2B but installs with + sign. These are the encoded chars in url strings. #hdiutil attach ${OS_NAME}.dmg #sed -i -e "s|REPLACEME|$HOME/openstudio|" ci/github-actions/install-mac.qs From 5984f060eabc3cecc8e88f507369694058d9624f Mon Sep 17 00:00:00 2001 From: Brian Ball Date: Mon, 23 Oct 2023 18:13:40 -0400 Subject: [PATCH 09/18] Update version.rb --- server/app/lib/openstudio_server/version.rb | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/server/app/lib/openstudio_server/version.rb b/server/app/lib/openstudio_server/version.rb index b292497d6..005b0eca3 100644 --- a/server/app/lib/openstudio_server/version.rb +++ b/server/app/lib/openstudio_server/version.rb @@ -4,9 +4,9 @@ # ******************************************************************************* module OpenstudioServer - VERSION = '3.6.1'.freeze + VERSION = '3.7.0'.freeze # format should be ^.*\-{1}[a-z]+[0-9]+ # for example: -rc1, -beta6, -customusecase0 - VERSION_EXT = ''.freeze # with preceding - or + - OS_SHA = 'bb9481519e'.freeze + VERSION_EXT = '-rc1'.freeze # with preceding - or + + OS_SHA = '211bb633b0'.freeze end From cb06d1f5269b8f5da5d144686a780ab82574bc77 Mon Sep 17 00:00:00 2001 From: Brian Ball Date: Tue, 24 Oct 2023 11:30:47 -0400 Subject: [PATCH 10/18] Update README.md --- README.md | 24 +++++++++--------------- 1 file changed, 9 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 6ccfebe7f..44afb64ee 100644 --- a/README.md +++ b/README.md @@ -9,14 +9,11 @@ The below documentation has not been recently reviewed. Please refer to the [wik ## Application Development and Deployment -There are primarily three ways to utilize and deploy this codebase. +There are primarily two ways to utilize and deploy this codebase. -* [openstudio_meta](./bin/openstudio_meta) CLI: Allows for the server to be deployed on a local -desktop without docker through a pre-compilation process of all required gem dependencies. Additionally, it allows for -cloud instances to be created and analyses run on them. -* [Docker Compose](https://docs.docker.com/compose/): This is the preferred environment for application development, as -it is allows for rapid iteration and does not encumber developers with deployment configuration details. -* [Docker Swarm](https://docs.docker.com/engine/swarm/): This is the recommended deployment pathway. Swarm is an +* [openstudio-server-helm](https://github.com/NREL/openstudio-server-helm) This helm chart installs a OpenStudio-server instance deployment on a AWS, Azure, or Google Kubernetes cluster using the Helm package manager. You can interface with the OpenStudio-server cluster using the Parametric Analysis Tool or the [openstudio_meta](./bin/openstudio_meta) CLI. + +* [Docker Swarm](https://docs.docker.com/engine/swarm/): This is the recommended local deployment pathway. Swarm is an orchestration engine which allows for multi-node clusters and provides significant benefits in the forms of customization and hardening of network and storage fundamentals. @@ -25,9 +22,8 @@ fundamentals. The [openstudio_meta](./bin/openstudio_meta) file is a ruby script which provides access to packaging and execution commands which allow for this codebase to be embedded in applications deployed to computers without docker. Deployment -requires that [MongoDB v3.2](https://www.mongodb.com/download-center#previous) and [Ruby v2.2](https://www.ruby-lang.org/en/news/2014/12/25/ruby-2-2-0-released/) -are additionally packaged. For an example of cross-platform deployment please see the OpenStudio build guide for the -[2.X releases](https://github.com/NREL/OpenStudio/wiki/Configuring-OpenStudio-Build-Environments) and the [CMake lists](https://github.com/NREL/OpenStudio/blob/develop/openstudiocore/CMakeLists.txt). +requires that [MongoDB 6.0.7](https://www.mongodb.com/download-center/community/releases/archive) and [Ruby v2.7](https://www.ruby-lang.org/en/downloads/) +are additionally packaged. The openstudio_meta deployment relies on the `install_gems` command, which uses local system libraries to build all required gem dependencies of the server. Additionally, the export flag allows for the resulting package to be @@ -35,11 +31,9 @@ automatically assembled and zipped for deployment. It is important to note that it is critical to not specify the export path with home (`~`) substitution. Instead, pass a fully specified path to the desired output directory. -Once compiled or unpacked, the openstudio_meta file can be used for starting and stopping local and remote server, and -submitting analyses to both. Assembling the required files for the analysis is left to either the OpenStudio Analysis -Spreadsheet (the Spreadsheet) or the Parametric Assessment Tool (PAT). The Spreadsheet has a similar interface for -submitting analyses to servers, and PAT makes complete use of the openstudio_meta features. For more details, please -refer to the [wiki](https://github.com/NREL/OpenStudio-server/wiki/CLI). +Once compiled or unpacked, the openstudio_meta file can be used for starting and stopping the local server for the Parametric Assessment Tool (PAT) and +submitting analyses to it. Assembling the required files for the analysis is done with the [Analysis-gem](https://github.com/NREL/OpenStudio-analysis-gem) or the export OSA function in the Parametric Assessment Tool (PAT). For more details, please +refer to the [wiki](https://github.com/NREL/OpenStudio-server/wiki/CLI). For examples, please refer to [OSAF notebooks](https://github.com/NREL/docker-openstudio-jupyter/tree/master). ### Local Docker Development From b24bfd8526a0d49bf37a8e72e69f1fbb0937f315 Mon Sep 17 00:00:00 2001 From: Brian Ball Date: Tue, 24 Oct 2023 12:20:34 -0400 Subject: [PATCH 11/18] Update README.md --- README.md | 32 +++++++++----------------------- 1 file changed, 9 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 44afb64ee..76f53989d 100644 --- a/README.md +++ b/README.md @@ -31,29 +31,23 @@ automatically assembled and zipped for deployment. It is important to note that it is critical to not specify the export path with home (`~`) substitution. Instead, pass a fully specified path to the desired output directory. -Once compiled or unpacked, the openstudio_meta file can be used for starting and stopping the local server for the Parametric Assessment Tool (PAT) and -submitting analyses to it. Assembling the required files for the analysis is done with the [Analysis-gem](https://github.com/NREL/OpenStudio-analysis-gem) or the export OSA function in the Parametric Assessment Tool (PAT). For more details, please +Once compiled or unpacked, the openstudio_meta file can be used for starting and stopping the local server for the [Parametric Analysis Tool (PAT)](https://github.com/NREL/OpenStudio-PAT) and +submitting analyses to it. Assembling the required files for the analysis is done with the [Analysis-gem](https://github.com/NREL/OpenStudio-analysis-gem) or the export OSA function in PAT. For more details, please refer to the [wiki](https://github.com/NREL/OpenStudio-server/wiki/CLI). For examples, please refer to [OSAF notebooks](https://github.com/NREL/docker-openstudio-jupyter/tree/master). ### Local Docker Development To develop locally the following dependency stack is recommended. -* Install Docker (Version 17.09.0 or greater is required) +* Install Docker (Version 20.10.5 or greater is required) * OSX Users: [install Docker CE for Mac](https://docs.docker.com/docker-for-mac/install/). Please refer to [this guide](https://docs.docker.com/docker-for-mac/install/) - * Windows 10 Users: [Docker CE for Windows](https://docs.docker.com/docker-for-windows/install/). More information - can be found in [this guide](https://docs.docker.com/docker-for-windows/). - * Pre Windows 10 Users: Use Docker Toolbox. You will need to install and configure dependencies, including [VirtualBox](https://docs.docker.com/toolbox/toolbox_install_windows/#next-steps). + * Windows 10 Users: [Docker Desktop](https://www.docker.com/products/docker-desktop/). * Linux Users: Follow the instructions in the [appropriate guide](https://www.docker.com/community-edition) *Note: Although generally newer versions of docker will behave as expected, certain CLI interactions change between releases, leading to scripts breaking and default behaviours, particularly regarding persistence, changing. The docker version installed and running can be found by typing `docker info` on the command line.* -* Install Docker Compose (Version 1.17.0 or greater is required) - * Docker compose will be installed on Mac and Windows by default - * Linux Users: See instructions [here](https://docs.docker.com/compose/install/) - #### Run Docker Compose ```bash @@ -101,21 +95,13 @@ docker-compose rm -f -### Docker Deployment +### Local Docker Deployment To deploy the OpenStudio Server in a docker-based production environment one or more machines need to be running Docker -Server version 17.9.01. If using docker on a Linux machine it is recommended that significant storage be available to -the `/var` folder. This is where Docker reads and writes all data to by default. In addition, advanced users may wish -to consider using specialized [storage drivers](https://docs.docker.com/engine/userguide/storagedriver/). Please refer -to the [wiki](https://github.com/NREL/OpenStudio-server/wiki) page for additional details and -a [configuration and reset guide](). Deploying a production docker swarm system outside of AWS (where complications -are managed and support by NREL) can be a non-trivial problem that may require significant systems administration -experience. Those embarking on this process are encouraged to refer to the scripts used by Packer to configure -[Ubuntu](https://github.com/NREL/OpenStudio-server/blob/develop/docker/deployment/scripts/aws_system_init.sh) and -[docker](https://github.com/NREL/OpenStudio-server/blob/develop/docker/deployment/scripts/aws_osserver_init.sh) in the -base AMI images, as well as the scripts used to provision the [server](https://github.com/NREL/OpenStudio-server/blob/develop/docker/deployment/scripts/server_provision.sh) -and [worker](https://github.com/NREL/OpenStudio-server/blob/develop/docker/deployment/scripts/worker_provision.sh) -nodes upon instantiation in a cluster. +Server version 20.10.05. If using docker on a Linux machine it is recommended that significant storage be available to +the `/var` folder. This is where Docker reads and writes all data to by default unless changed in the docker-compose.yml file. +There are scripts to help with docker swarm deployment [here](https://github.com/NREL/OpenStudio-server/tree/develop/local_setup_scripts). +Make sure to change the defaults to be applicable to your hardware requirements. ## Testing procedure From c601b3296068117f329b54e82c7bc97d449ef5f7 Mon Sep 17 00:00:00 2001 From: Brian Ball Date: Tue, 24 Oct 2023 12:25:30 -0400 Subject: [PATCH 12/18] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 76f53989d..e9666df76 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Windows Build (Under Development): [![Windows Build Status][appveyor-img]][appveyor-url] -The below documentation has not been recently reviewed. Please refer to the [wiki](https://github.com/NREL/OpenStudio-server/wiki) for current documentation. +Please refer to the [wiki](https://github.com/NREL/OpenStudio-server/wiki) for additional documentation. ## Application Development and Deployment From edbf749493d7e6eb2bf37b465095b1334383d7ee Mon Sep 17 00:00:00 2001 From: Brian Ball Date: Tue, 24 Oct 2023 12:27:59 -0400 Subject: [PATCH 13/18] Update README.md --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index e9666df76..b099f9be5 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,6 @@ [![Build Status][gh-img]][gh-url] [![Coverage Status][coveralls-img]][coveralls-url] -Windows Build (Under Development): [![Windows Build Status][appveyor-img]][appveyor-url] - Please refer to the [wiki](https://github.com/NREL/OpenStudio-server/wiki) for additional documentation. ## Application Development and Deployment From 29e93ee9756b2ab17db4e347d484d78aefa3688b Mon Sep 17 00:00:00 2001 From: Brian Ball Date: Tue, 24 Oct 2023 12:53:34 -0400 Subject: [PATCH 14/18] Update README.md --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index b099f9be5..73783c398 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,12 @@ Please refer to the [wiki](https://github.com/NREL/OpenStudio-server/wiki) for additional documentation. +## About + +OpenStudio Server is a web application and distributed computing tool intended to make parametric analysis of building energy models accessible to architects, engineers, and designers via the [OpenStudio PAT](http://nrel.github.io/OpenStudio-user-documentation/reference/parametric_studies/) GUI and a web dashboard. OpenStudio Server analyses are defined by PAT projects or OSA's. Each analysis may include many OpenStudio simulations, as determined by project configuration. + +Journal of Building Performance Simulation [An open source analysis framework for large-scale building energy modeling](https://www.tandfonline.com/doi/full/10.1080/19401493.2020.1778788) + ## Application Development and Deployment There are primarily two ways to utilize and deploy this codebase. From 9ea7935a2950fd782fdedb4156cbae1b9d6afa33 Mon Sep 17 00:00:00 2001 From: Brian Ball Date: Tue, 24 Oct 2023 13:39:04 -0400 Subject: [PATCH 15/18] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 73783c398..9b9404962 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,15 @@ Please refer to the [wiki](https://github.com/NREL/OpenStudio-server/wiki) for additional documentation. + + + + ## About OpenStudio Server is a web application and distributed computing tool intended to make parametric analysis of building energy models accessible to architects, engineers, and designers via the [OpenStudio PAT](http://nrel.github.io/OpenStudio-user-documentation/reference/parametric_studies/) GUI and a web dashboard. OpenStudio Server analyses are defined by PAT projects or OSA's. Each analysis may include many OpenStudio simulations, as determined by project configuration. -Journal of Building Performance Simulation [An open source analysis framework for large-scale building energy modeling](https://www.tandfonline.com/doi/full/10.1080/19401493.2020.1778788) +Journal of Building Performance Simulation article: [An open source analysis framework for large-scale building energy modeling](https://www.tandfonline.com/doi/full/10.1080/19401493.2020.1778788) ## Application Development and Deployment From 7a744a3739ff5c94ed58a428f09ff15a12a84401 Mon Sep 17 00:00:00 2001 From: Brian Ball Date: Tue, 24 Oct 2023 13:40:18 -0400 Subject: [PATCH 16/18] Update README.md --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 9b9404962..192aaa0f8 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,6 @@ Please refer to the [wiki](https://github.com/NREL/OpenStudio-server/wiki) for a - ## About OpenStudio Server is a web application and distributed computing tool intended to make parametric analysis of building energy models accessible to architects, engineers, and designers via the [OpenStudio PAT](http://nrel.github.io/OpenStudio-user-documentation/reference/parametric_studies/) GUI and a web dashboard. OpenStudio Server analyses are defined by PAT projects or OSA's. Each analysis may include many OpenStudio simulations, as determined by project configuration. From a1b7004c60d2cf18b7403f1a47b425e4a5e4de83 Mon Sep 17 00:00:00 2001 From: Brian Ball Date: Tue, 24 Oct 2023 13:47:43 -0400 Subject: [PATCH 17/18] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 192aaa0f8..ace9ceba1 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,9 @@ Please refer to the [wiki](https://github.com/NREL/OpenStudio-server/wiki) for a ## About -OpenStudio Server is a web application and distributed computing tool intended to make parametric analysis of building energy models accessible to architects, engineers, and designers via the [OpenStudio PAT](http://nrel.github.io/OpenStudio-user-documentation/reference/parametric_studies/) GUI and a web dashboard. OpenStudio Server analyses are defined by PAT projects or OSA's. Each analysis may include many OpenStudio simulations, as determined by project configuration. +OpenStudio Server is a web application and distributed computing tool, which is the backbone of the OpenStudio Analysis Framework (OSAF). +It is intended to make parametric analysis of building energy models accessible to architects, engineers, and designers via the [OpenStudio PAT](http://nrel.github.io/OpenStudio-user-documentation/reference/parametric_studies/) GUI or the [OpenStudio Analysis Gem](https://github.com/NREL/OpenStudio-analysis-gem). +OpenStudio Server analyses are defined by PAT projects or OSA's. Each analysis may include many OpenStudio simulations, as determined by project configuration. Journal of Building Performance Simulation article: [An open source analysis framework for large-scale building energy modeling](https://www.tandfonline.com/doi/full/10.1080/19401493.2020.1778788) From 6d6e7b63ed642a254c294f28bfb2ff7d08c3e562 Mon Sep 17 00:00:00 2001 From: Brian Ball Date: Tue, 24 Oct 2023 13:54:28 -0400 Subject: [PATCH 18/18] Update README.md --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ace9ceba1..87713250c 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ To develop locally the following dependency stack is recommended. releases, leading to scripts breaking and default behaviours, particularly regarding persistence, changing. The docker version installed and running can be found by typing `docker info` on the command line.* -#### Run Docker Compose +#### Docker Compose ```bash docker-compose build @@ -102,9 +102,7 @@ git checkout -- .dockerignore && git checkout -- Dockerfile docker-compose rm -f ``` - - -### Local Docker Deployment +### Local Docker Swarm Deployment To deploy the OpenStudio Server in a docker-based production environment one or more machines need to be running Docker Server version 20.10.05. If using docker on a Linux machine it is recommended that significant storage be available to