Question-and-Answer Resource for the Building Energy Modeling Community
Get started with the Help page
Ask Your Question

Building OpenStudio Server for

asked 2018-11-09 13:26:56 -0500

mldichter's avatar

I am confused on these instructions.

First, the instructions specifically list different operating systems, and Windows Server 2016 is not among them. Are these instructions also applicable to Windows Server operating systems? If not, could you please direct me to instructions applicable to Windows Server 2016?

Second, what are the "Employ OpenStudio naming convention" mentioned on the second to last line?

Third, are there any additional instructions for setting up the Amazon AWS and connecting the S3 bucket?

Finally, super duper awesome if there are any instructions that don't require use of Amazon AWS? I would like to get openstudio-server working on the Windows server in my office, but I'd settle for working in any capacity at this point.

image description

edit retag flag offensive close merge delete

2 Answers

Sort by ยป oldest newest most voted

answered 2018-11-09 16:48:51 -0500

For now The wiki on openstudio-server repo is the best place to look.

edit flag offensive delete link more


@David Goldwasser Could you please delete this page from the web if these instructions are inferior to the instructions here?

mldichter's avatar mldichter  ( 2018-11-09 17:36:51 -0500 )edit

answered 2018-11-12 10:58:04 -0500

Creating your own instance of OS-Server is no trivial task (ie, one size does not fit all), but here are some scripts that I use to do local deployments of OS-Server. The scripts are assumed to live in your home directory.

We currently use Docker 17.09.1-ce on Ubuntu 16.04 LTS, so make sure you have that setup correctly and '>Docker info' gives the right architecture and right number of CPUs.

OS-Server uses Docker Swarm to setup and scale the worker nodes. The bash script '' will setup a Docker Registry and then pull the docker containers (with version given as an input argument,i.e. > 2.7.0) and then push them to the local Registry. Line 42 then scales the number of worker nodes to be 42 but you probably want to change that to the number of worker cores avail on your box.

There is also the docker-compose.yml file that needs to get configured. There are Environment Variables that need to get set to your server configuration. You can either replace them with values in the file or set actual ENV Vars:

  • AWS_MONGO_CORES - ceil(number_of_cpus / 64)
  • AWS_MAX_REQUESTS - round((number_of_cpus + 10) * 1.2)
  • AWS_WEB_CORES - ceil(number_of_cpus / 32)

You can also experiment with replacing CPU reservations to limits, depending on the needs of you specific hardware. (

Ideally, all you'd have to do is run '> 2.7.0' from your home directory and that script will download version 2.7.0 of the related OS-Server containers, Mongo, Reddis and put them in a local Registry. Then setup the Volumes needed for the containers, create the Swarm and deploy the Stack and scale to the number of workers you select.



edit flag offensive delete link more


@BrianLBall Thanks for the input, but the "Creating your own instance of OS-Server is no trivial task" is the problem we're having. The people on this project are HVAC engineers after all, not computer scientists.

mldichter's avatar mldichter  ( 2018-11-13 13:27:50 -0500 )edit

@BrianLBall Also, a goal of our project is to release the openstudio measures so other researchers can apply the same process to their own building models. In that respect, we want to make using the measures easy, which is a major disadvantage of AWS for HVAC engineers. @mdahlhausen has alerted me of an alternative to using PAT here. While inferior in some ways openstudio-server, it is far superior in that it looks easier to setup. I'll be trying it out today.

mldichter's avatar mldichter  ( 2018-11-13 13:31:03 -0500 )edit

Your Answer

Please start posting anonymously - your entry will be published after you log in or create a new account.

Add Answer


Question Tools

1 follower


Asked: 2018-11-09 13:26:56 -0500

Seen: 314 times

Last updated: Nov 12 '18