Table of Contents

• Installation
• License
• Setting up a Visual Studio Code Development Environment

pip install energyplus-version

energyplus-version is distributed under the terms of the BSD-3-Clause license.

To set up a Visual Studio Code development environment, first install Python. Next, install Visual Studio code and the Python extension(s) from Microsoft. Next, install hatch with

pip install hatch

Clone the repository to the location of your choice and get a command window running in that location. In the root folder of the repo, execute the following to generate an environment that has everything that is needed:

hatch env create

When that is done, there should now be an environment ready that will have the package installed. To point Visual Studio Code at the created environment, execute

hatch run python -c "import sys;print(sys.executable)"

and copy the result. In Visual Studio Code, hit ctrl-shift-P to bring up the command palette, select "Python: Select Interpreter", and paste in the result from above. Any warnings (yellow squiqqly underlines) in the source files should go away. To make sure that everything has worked, run

hatch shell

to enter the environment that was created, and then execute

energyplus-version --help

You should see the help output from the tool. Typing exit will exit the shell.