Important Note

Active development of OpenStudio has moved from the Legacy OpenStudio Plug-in listed here to the more comprehensive OpenStudio suite of tools and libraries at http://openstudio.nrel.gov. This new project includes C++, Ruby, and C# libraries as well as several user interfaces, including a new SketchUp Plug-in with enhanced capabilities, which are all licensed under the LGPL to encourage reuse by commercial and non-commercial third-party software. The mailing lists, bug and feature trackers on this page are intended for news and support of the Legacy OpenStudio Plug-in only. For information or support for the new OpenStudio project, please refer to http://openstudio.nrel.gov. NREL sponsored changes to the Legacy OpenStudio Plug-in will be limited to bug fixes and compatibility updates for new versions of EnergyPlus.

About the Legacy OpenStudio Plug-in

The Legacy OpenStudio Plug-in makes it easy to create and edit the building geometry in your EnergyPlus input files. It also allows you to launch EnergyPlus simulations and view the results without leaving SketchUp.

The Legacy OpenStudio Plug-in was created by the National Renewable Energy Laboratory for the U.S. Department of Energy. Refer to the webpage on energyplus.gov for an overview of the concept and features.

The Legacy OpenStudio Plug-in is an open source project hosted on SourceForge.net--visit the project website here:
http://sourceforge.net/projects/openstudio/.

This webpage serves as a guide to the SourceForge collaborative project resources for:

System Requirements

Windows XP/Vista/System 7 or Mac OS X 10.5+
Google SketchUp 7 or later (Free or Pro)
EnergyPlus 7.0

Download

Register and download the installer for the Legacy OpenStudio Plug-in here: Download Now


EnergyPlus Logo       SourceForge.net Logo       GPL v3 Logo

Users

The collaborative project website on SourceForge offers several benefits for users:

Mailing Lists

There are two mailing lists intended for users of the Legacy OpenStudio Plug-in. We highly recommend that you subscribe in order to keep up-to-date on the latest developments:

To join these lists, visit the links above or send a blank email to openstudio-announce-join@lists.sourceforge.net or openstudio-support-join@lists.sourceforge.net.

To post a message on the support list, send your email to openstudio-support@lists.sourceforge.net. NOTE: You must join the list before you will be allowed to post.

All mailing list posts are preserved in searchable archives:

Before you post to the support list, it's a good idea to browse or search the archives to see if someone posted about the same issue already. You can search the archives here.

Trackers

The project website also hosts trackers for bugs and feature requests. You can browse the trackers to see what bugs and features are in the queue to be addressed in future releases:

If you post a bug on the openstudio-support mailing list and it is a previously unknown bug, we will add a new bug entry to the bug tracker and send you back a URL that you can use to track the status of the bug. Likewise for feature requests.

You can also add a new entry directly to either tracker yourself. You will need your own (free) SourceForge account to do this. The advantage of adding the entry yourself is that you can automatically receive update emails when the status changes. Both trackers also allow you to attach files--which is greatly appreciated when we try to reproduce your bug later.

Support

Although there are multiple ways of getting user support for the Legacy OpenStudio Plug-in, the openstudio-support mailing list is the preferred support mechanism for most issues.

For help with EnergyPlus, visit the EnergyPlus support webpage for details here.

Documentation

Help documentation is distributed with the Legacy OpenStudio Plug-in and is accessible from the Help toolbar button or the menu command Plug-ins/OpenStudio/User Guide.

How To Help

You don't have to be a developer to help make the Legacy OpenStudio Plug-in better. There are several ways that you can contribute to the Legacy OpenStudio Plug-in as a user:

Developers

The collaborative project website on SourceForge includes source code management (via Subversion), trackers, mailing lists, and other goodies.

The project website is here: http://sourceforge.net/projects/openstudio/

Source Code

You can check out the latest "bleeding edge" source code--before the official release--using any Subversion client. SourceForge describes access to the Subversion repository here.

For example, if you are using the TortoiseSVN client and want to check out the latest revision of the trunk, set the repository URL to: http://openstudio.svn.sourceforge.net/svnroot/openstudio/trunk/OpenStudio

Documentation

RDoc documentation for the source code is distributed with the standard installation of the Legacy OpenStudio Plug-in. You can find it in the SketchUp Plug-ins directory at \OpenStudio\doc\developer\index.html

License

The Legacy OpenStudio Plug-in is licensed as open source under the GNU General Public License v3.

Mailing Lists

In addition to the user mailing lists (openstudio-announce and openstudio-support), you might also want to subscribe to the developers' mailing list and the Subversion commit log mailing list:

Help Wanted

We welcome new developers to help us improve the Legacy OpenStudio Plug-in. If you would like to become a developer, you can begin contributing to the project in a couple ways:

"Patches" are a set of new or modified files that fix a bug or add a new feature. When a patch is received, it is reviewed by one of the other developers and then committed to the Subversion repository by a developer with commit privileges.

There is no set policy yet for determining how a developer can earn commit privileges. A history of posting good patches will certainly help your case. Once you do receive your own commit privileges, you will be able to commit your patches directly to the Subversion repository. (You will need your own SourceForge account.)

Looking for something to work on? You can browse for ideas among the unresolved bugs and feature requests on the bug tracker and feature request tracker respectively. Or come up with the next great idea yourself!

Questions?

Have questions about the development process? Thinking about contributing code? Planning a future project that might fit well with the Legacy OpenStudio Plug-in or with the new OpenStudio project? We are eager to nurture collaborations of any size. Send us an email at openstudio@nrel.gov.