The Building Component Library
The BCL is an online repository of components and measures that can be used in OpenStudio. Registering on the BCL website provides you with an API key that can be used by the OpenStudio Application to access online components and measures. BCL users who belong to a group can also upload their own content—public or private—to the BCL. Users can either create a new group or request to join an existing one. The following tutorial provides information on common BCL tasks.
Creating a Group
To create a group, first login to the site and click the My Dashboard link at the top right of the BCL site. Click on the Create Content tab, and then the Group button. Fill out the form and click the Save button.
A note on group visibility: if you create a private group, BCL users will not be able to see the group, or request membership. You will have to manually add all users to the group (see Adding a Member to a Group). Additionally, creating a public group does not restrict you to having only public content; a public group can have both public and private content.
Once you submit the form, a BCL admin will be notified and will review your group creation request. You will receive an email when the group is approved, at which time you can upload content.
Joining a Group
To join a public group, click the Groups button on the BCL homepage. Select the group you would like to join and click the Subscribe to Group or Request Group Membership button. Your membership will be pending until the group admin reviews and approves your request.
Adding a Member to a Group
If you are a group administrator, you can add members to your group by clicking the My Dashboard link at the top right of the page, then clicking on the My groups tab. Your group should now be listed on the page. Click on the linked group's name, which will take you to the group description page.
Click on the Group tab at the top of the page.
From this page you can add new members by clicking on the Add people link.
New members will need to provide you with their BCL account username.
Approving a Membership
If you are the group admin of a public group, you can approved requested memberships to your group by clicking the My Dashboard link at the top right of the page and then clicking on the My groups tab. Your group should now be listed on the page. Click on the linked group's name, which will take you to the group description page.
Click on the "Group" tab at the top of the page. You can then approve pending memberships by clicking on the People link.
Check the checkbox next to the pending users to approve, choose Modify membership status from the Operations dropdown, and press the Execute button.
Change the membership status to Active and click Next, then Confirm.
You can follow steps similar to these to remove a user from a group. Check the checkbox next to the user to remove, choose Remove from Group from the Operations dropdown, and click the Execute button. You can also change a user's group permissions by assigning group roles. Choose Modify OG User Role from the Operations dropdown, and click the *Execute button. Group roles are described in the next section.
There are 4 roles that users can have relative to the group to which they belong: group manager, administrator member, editor, and member.
Group Manager: This role is assigned to the user who created the group. There is only one group manager per group, and this user will receive e-mails when other users request membership to the group.
Administrator Member: Users with the administrator role can assign roles to other group users and approve group membership. They can also edit the group description and review, publish, and delete group content.
Editor: Users with the editor role can review and publish group content.
Member: The member role is the default role assigned to new group members. These users can create draft content and submit content for review. An editor or administrator member of the group will then need to review and publish it.
Uploading and Publishing Content
There are 2 types of content on the BCL: components and measures. Components are the building blocks of an energy model, and include roofs, walls, windows, occupancy and equipment schedules, and weather information, to name a few. Measures describe a change to an energy model for purposes such as comparison to a baseline model or estimation of potential energy savings. Users must be part of a group to upload content, and only group admins can publish content for their group. Although the instructions below pertain to measures, a similar process can be followed for uploading and updating components.
Creating the Measure Zip File
New measures are made in the OpenStudio application or Parametric Analysis tool by either creating a new measure or cloning an existing one. OpenStudio will place all necessary files in the directory set under preferences as My Measures Directory. Go within the directory for the measure and compress the files as shown below. Confirm that the xml file is updated after your last edit of the measure.rb file by clicking the Sync Project Measures with Library button or opening the Apply Measure Now dialog.
Additional details on the xml and other files can be found below:
The measure package to upload should contain a measure.xml file created with the current measure schema, available on the BCL website. The <uid> and <version_id> fields can be left blank as they will be assigned by the BCL.
Make sure to include the type of your measure in the <tag> field. Select from the available BCL measure types, and include the full hierarchy. This is usually 2 or 3 levels separated by a dot. For example, if you are uploading a space types measure, the <tag> should be: Whole Building.Space Types. If you do not see a suitable measure type for your measure in the list, please contact us. Attributes can also be applied to measures via the measure.xml file. Consult the supported list of BCL attributes to view the correct names. For more detailed information on writing OpenStudio measures, consult the Measure Writing Guide for further details.
The package should also contain the associated files referenced inside the measure.xml file's <files> section. These files should be contained in directories according to usage type: the main measure file, usually named measure.rb should be compressed directly (same level as measure.xml), resource files should be in a resources directory, and test files should be in a tests directory. The compressed package should directly contain these files and directories; the upload will fail if the package has an inner directory containing the files.
Uploading the Measure Zip File
To begin, click on the My Dashboard link at the top right of the BCL site. Click on the Create content tab. You should see a list of buttons. Press the Upload Measure button, which will direct you to a multi-tab form.
The Data tab contains a file upload field that will accept either a zip measure or a tar.gz measure package. The Group tab contains a list of the groups with which you are affiliated. Select the appropriate group, as well as your desired content visibility for this measure (public or private to the group). Save the form.
Once the measure has been saved, follow instructions in the Publishing Content section below for instructions on making the measure visible to others.
Editing an Existing Measure
If you want to update a measure that has already been uploaded to the BCL, first go to the URL for your component and click the Upload New Version button. To properly update an existing measure, you must re-upload the entire updated zip file.
Once the new version of the measure has been saved, follow instructions in the Publishing Content section below for instructions on making the measure visible to others.
All members of a group can add content to the BCL, but only users with the editor or administrator member group roles can review and publish their group's content. Content can be published by clicking the My Dashboard link at the top right of the page, then clicking on the My content tab and selecting the group content sub-tab.
Content in either the Draft or Needs Review states can be published by changing the moderation state to Published. The intended workflow is as follows:
- A content author creates a component or measure. The content is in the Draft state.
- Once the author is satisfied with the content, he/she sets the state to Needs Review. This indicates to the group editors and administrators that content is ready to be reviewed and published.
- Once reviewed, a group editor or administrator sets the state to *Published.
- The process is repeated for future revisions to the content.