Skip to content

Commit 219ac85

Browse files
JieXiong9119kflemin
JieXiong9119
and
kflemin
authored
Release BuildingSync 2.6.0 (#190)
* schema, examples and changlog update * scripts update * update README.md * Update CHANGELOG.md --------- Co-authored-by: Katherine Fleming <2205659+kflemin@users.noreply.github.com>
1 parent f004b52 commit 219ac85

23 files changed

+26833
-16
lines changed

‎CHANGELOG.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22

33
## Version 1.3.0
44

5-
This version replaces the old `selection-tool` names with `buildingsync-website`.
5+
- Replaces the old `selection-tool` names with `buildingsync-website`.
6+
- Release BuildingSync 2.6
7+
- Update documentation for BuildingSync 2.6
8+
- Prep for BEDES v2.6 mapping
69

710
## Version 1.2.0
811

‎README.md

+9-8
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ To parse and map a new BEDES version:
251251
1. Parse the BEDES XMLs into a JSON file and map the BEDES terms to the BuildingSync attributes:
252252
253253
```bash
254-
docker exec -it buildingsyncwebsite_web_1 bash
254+
docker exec -it buildingsync-website-web-1 bash
255255
python manage.py bedes --schema_version=X.X.X --bedes_version=X.X
256256
```
257257
@@ -263,7 +263,7 @@ To parse and map a new BEDES version:
263263
1. Copy the generated bedes files to the git repo on the production server. The command will be something like:
264264
265265
```
266-
docker cp buildingsyncwebsite_web_1:/srv/selection-tool/bsyncviewer/lib/bedes/v2.5/schema2.5.0 .
266+
docker cp buildingsync-website-web-1:/srv/buildingsync-website/bsyncviewer/lib/bedes/v2.5/schema2.5.0 .
267267
```
268268
269269
1. Review these mapping files and make changes as needed. Commit and push the files to the BuildingSync-website repository (ideally a branch).
@@ -283,14 +283,15 @@ Admin interface is available at `/admin`
283283
284284
Follow these steps to add a new schema version to the selection tool:
285285
286-
1. Add the schema file in the admin interface. Must have admin privileges. The schema will get automatically parsed. Manually add the enumeration.json file created from the release, hit the "Save" button once and wait patiently until it shows success.
287-
2. Update the versions in the DEFAULT_SCHEMA_VERSION in the dev.py, gh_actions.py, and docker.py with the latest release.
288-
3. Convert existing use cases schematron files to the new schema. Add the new use cases.
289-
4. When the use cases have been reviewed, make them public in the admin interface. Add the schematron file and hit "Save" once and wait for each use case.
286+
1. Add the schema file in the admin interface (may test it locally first). Must have admin privileges. The schema will get automatically parsed. Manually add the enumeration.json file created from the [release](https://github.com/BuildingSync/schema/releases), hit the "Save" button once and wait patiently until it shows success.
287+
2. Convert existing use cases schematron files to the new schema. Add the new use cases.
288+
3. When the use cases have been reviewed, make them public in the admin interface. Add the schematron file and hit "Save" once and wait for each use case.
289+
4. Update the versions in the DEFAULT_SCHEMA_VERSION in the dev.py, gh_actions.py, and docker.py with the latest release.
290290
5. Create XML example files and place them in the `bsyncviewer/lib/validator/examples/schema<VERSION>` directory. Make sure that the example_files.zip file is updated if any of the example files have changed (This is likely since the new example files will be pointing to the new schema).
291291
6. Test the validator with a local new XML example file.
292-
7. Reparse BEDES terms to map them to the new schema following the steps in the BEDES section above.
293-
8. Deploy website on production
292+
7. Create PR and merge with the changes.
293+
8. Reparse BEDES terms to map them to the new schema following the steps in the BEDES section above.
294+
9. Deploy website on production.
294295
295296
### Adding Examples from the TestSuite repo
296297

‎bsyncviewer/lib/buildingsync_schemas/BuildingSync_v2.6.0.xsd

+17,387
Large diffs are not rendered by default.

‎bsyncviewer/lib/validator/examples/schema2.6.0/BETTER_SampleCourthouse.xml

+642
Large diffs are not rendered by default.

‎bsyncviewer/lib/validator/examples/schema2.6.0/BETTER_SampleOffice.xml

+514
Large diffs are not rendered by default.

‎bsyncviewer/lib/validator/examples/schema2.6.0/Example – A Valid Schema.xml

+168
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,168 @@
1+
<auc:BuildingSync xmlns:auc="http://buildingsync.net/schemas/bedes-auc/2019" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://buildingsync.net/schemas/bedes-auc/2019 https://raw.githubusercontent.com/BuildingSync/schema/v2.6.0/BuildingSync.xsd" version="2.6.0">
2+
<auc:Facilities>
3+
<auc:Facility ID="Facility1">
4+
<auc:Sites>
5+
<auc:Site ID="Site1">
6+
<auc:PremisesIdentifiers>
7+
<auc:PremisesIdentifier>
8+
<auc:IdentifierLabel>Custom</auc:IdentifierLabel>
9+
<auc:IdentifierCustomName>Tax Lot</auc:IdentifierCustomName>
10+
<auc:IdentifierValue>001</auc:IdentifierValue>
11+
</auc:PremisesIdentifier>
12+
<auc:PremisesIdentifier>
13+
<auc:IdentifierLabel>Custom</auc:IdentifierLabel>
14+
<auc:IdentifierCustomName>Borough</auc:IdentifierCustomName>
15+
<auc:IdentifierValue>Brooklyn</auc:IdentifierValue>
16+
</auc:PremisesIdentifier>
17+
<auc:PremisesIdentifier>
18+
<auc:IdentifierLabel>Custom</auc:IdentifierLabel>
19+
<auc:IdentifierCustomName>Tax Block</auc:IdentifierCustomName>
20+
<auc:IdentifierValue>001</auc:IdentifierValue>
21+
</auc:PremisesIdentifier>
22+
</auc:PremisesIdentifiers>
23+
<auc:Address>
24+
<auc:City>New York</auc:City>
25+
<auc:State>NY</auc:State>
26+
</auc:Address>
27+
<auc:Buildings>
28+
<auc:Building ID="Building001">
29+
<auc:PremisesName>Building 001</auc:PremisesName>
30+
<auc:PremisesNotes/>
31+
<auc:PremisesIdentifiers>
32+
<auc:PremisesIdentifier>
33+
<auc:IdentifierLabel>Custom</auc:IdentifierLabel>
34+
<auc:IdentifierCustomName>Custom ID 1</auc:IdentifierCustomName>
35+
<auc:IdentifierValue>001</auc:IdentifierValue>
36+
</auc:PremisesIdentifier>
37+
</auc:PremisesIdentifiers>
38+
<auc:Address>
39+
<auc:StreetAddressDetail>
40+
<auc:Simplified>
41+
<auc:StreetAddress>123 Main St</auc:StreetAddress>
42+
</auc:Simplified>
43+
</auc:StreetAddressDetail>
44+
<auc:City>New York</auc:City>
45+
<auc:State>NY</auc:State>
46+
<auc:PostalCode>11520</auc:PostalCode>
47+
</auc:Address>
48+
<auc:FloorAreas>
49+
<auc:FloorArea>
50+
<auc:FloorAreaType>Gross</auc:FloorAreaType>
51+
<auc:FloorAreaValue>75000</auc:FloorAreaValue>
52+
</auc:FloorArea>
53+
<auc:FloorArea>
54+
<auc:FloorAreaType>Heated and Cooled</auc:FloorAreaType>
55+
<auc:FloorAreaValue>75000</auc:FloorAreaValue>
56+
</auc:FloorArea>
57+
<auc:FloorArea>
58+
<auc:FloorAreaType>Footprint</auc:FloorAreaType>
59+
<auc:FloorAreaValue>80000</auc:FloorAreaValue>
60+
</auc:FloorArea>
61+
</auc:FloorAreas>
62+
<auc:AspectRatio>3.6732677131179763</auc:AspectRatio>
63+
<auc:Perimeter>1350</auc:Perimeter>
64+
<auc:YearOfConstruction>1960</auc:YearOfConstruction>
65+
<auc:YearOfLastMajorRemodel>2008</auc:YearOfLastMajorRemodel>
66+
<auc:Sections>
67+
<auc:Section ID="Default_Subsection">
68+
<auc:SectionType>Whole building</auc:SectionType>
69+
<auc:OccupancyClassification>Retail</auc:OccupancyClassification>
70+
<auc:TypicalOccupantUsages>
71+
<auc:TypicalOccupantUsage>
72+
<auc:TypicalOccupantUsageValue>40.0</auc:TypicalOccupantUsageValue>
73+
<auc:TypicalOccupantUsageUnits>Hours per week</auc:TypicalOccupantUsageUnits>
74+
</auc:TypicalOccupantUsage>
75+
<auc:TypicalOccupantUsage>
76+
<auc:TypicalOccupantUsageValue>50.0</auc:TypicalOccupantUsageValue>
77+
<auc:TypicalOccupantUsageUnits>Weeks per year</auc:TypicalOccupantUsageUnits>
78+
</auc:TypicalOccupantUsage>
79+
</auc:TypicalOccupantUsages>
80+
<auc:FloorAreas>
81+
<auc:FloorArea>
82+
<auc:FloorAreaType>Gross</auc:FloorAreaType>
83+
<auc:FloorAreaValue>69452</auc:FloorAreaValue>
84+
</auc:FloorArea>
85+
<auc:FloorArea>
86+
<auc:FloorAreaType>Tenant</auc:FloorAreaType>
87+
<auc:FloorAreaValue>69452</auc:FloorAreaValue>
88+
</auc:FloorArea>
89+
<auc:FloorArea>
90+
<auc:FloorAreaType>Common</auc:FloorAreaType>
91+
<auc:FloorAreaValue>0.0</auc:FloorAreaValue>
92+
</auc:FloorArea>
93+
</auc:FloorAreas>
94+
</auc:Section>
95+
</auc:Sections>
96+
</auc:Building>
97+
</auc:Buildings>
98+
</auc:Site>
99+
</auc:Sites>
100+
<auc:Measures>
101+
<auc:Measure ID="Measure1">
102+
<auc:SystemCategoryAffected>Lighting</auc:SystemCategoryAffected>
103+
<auc:LinkedPremises>
104+
<auc:Building>
105+
<auc:LinkedBuildingID IDref="Building001"/>
106+
</auc:Building>
107+
</auc:LinkedPremises>
108+
<auc:TechnologyCategories>
109+
<auc:TechnologyCategory>
110+
<auc:LightingImprovements>
111+
<auc:MeasureName>Retrofit with light emitting diode technologies</auc:MeasureName>
112+
</auc:LightingImprovements>
113+
</auc:TechnologyCategory>
114+
</auc:TechnologyCategories>
115+
<auc:MeasureScaleOfApplication>Entire building</auc:MeasureScaleOfApplication>
116+
<auc:LongDescription>Retrofit with light emitting diode technologies</auc:LongDescription>
117+
<auc:MVCost>0</auc:MVCost>
118+
<auc:UsefulLife>12</auc:UsefulLife>
119+
<auc:MeasureTotalFirstCost>267390.2</auc:MeasureTotalFirstCost>
120+
<auc:MeasureInstallationCost>0</auc:MeasureInstallationCost>
121+
<auc:MeasureMaterialCost>0</auc:MeasureMaterialCost>
122+
<auc:Recommended>true</auc:Recommended>
123+
<auc:ImplementationStatus>Proposed</auc:ImplementationStatus>
124+
<auc:UserDefinedFields>
125+
<auc:UserDefinedField>
126+
<auc:FieldName>Rebate Available</auc:FieldName>
127+
<auc:FieldValue>true</auc:FieldValue>
128+
</auc:UserDefinedField>
129+
</auc:UserDefinedFields>
130+
</auc:Measure>
131+
</auc:Measures>
132+
<auc:Reports>
133+
<auc:Report ID="Report1">
134+
<auc:Scenarios>
135+
<auc:Scenario ID="Baseline">
136+
<auc:ScenarioName>Baseline</auc:ScenarioName>
137+
<auc:ScenarioType>
138+
<auc:PackageOfMeasures ID="Package-Baseline">
139+
</auc:PackageOfMeasures>
140+
</auc:ScenarioType>
141+
</auc:Scenario>
142+
<auc:Scenario ID="Scenario1">
143+
<auc:ScenarioName>LED Only</auc:ScenarioName>
144+
<auc:ScenarioType>
145+
<auc:PackageOfMeasures ID="Package-Scenario1">
146+
<auc:MeasureIDs>
147+
<auc:MeasureID IDref="Measure1"/>
148+
</auc:MeasureIDs>
149+
</auc:PackageOfMeasures>
150+
</auc:ScenarioType>
151+
<auc:LinkedPremises>
152+
<auc:Building>
153+
<auc:LinkedBuildingID IDref="Building001"/>
154+
</auc:Building>
155+
</auc:LinkedPremises>
156+
<auc:UserDefinedFields>
157+
<auc:UserDefinedField>
158+
<auc:FieldName>Recommended Resource Savings Category</auc:FieldName>
159+
<auc:FieldValue>Potential Capital Recommendations</auc:FieldValue>
160+
</auc:UserDefinedField>
161+
</auc:UserDefinedFields>
162+
</auc:Scenario>
163+
</auc:Scenarios>
164+
</auc:Report>
165+
</auc:Reports>
166+
</auc:Facility>
167+
</auc:Facilities>
168+
</auc:BuildingSync>

0 commit comments

Comments
 (0)