Skip to content

Commit

Permalink
Release BuildingSync 2.6.0 (#190)
Browse files Browse the repository at this point in the history 
* schema, examples and changlog update

* scripts update

* update README.md

* Update CHANGELOG.md

---------

Co-authored-by: Katherine Fleming <[email protected]>
  • Loading branch information
@JieXiong9119 @kflemin
JieXiong9119 and kflemin authored Oct 8, 2024
1 parent f004b52 commit 219ac85
Show file tree
Hide file tree
Showing 23 changed files with 26,833 additions and 16 deletions.
5 changes: 4 additions & 1 deletion CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@

## Version 1.3.0

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

## Version 1.2.0

Expand Down
17 changes: 9 additions & 8 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ To parse and map a new BEDES version:
1. Parse the BEDES XMLs into a JSON file and map the BEDES terms to the BuildingSync attributes:
```bash
docker exec -it buildingsyncwebsite_web_1 bash
docker exec -it buildingsync-website-web-1 bash
python manage.py bedes --schema_version=X.X.X --bedes_version=X.X
```
Expand All @@ -263,7 +263,7 @@ To parse and map a new BEDES version:
1. Copy the generated bedes files to the git repo on the production server. The command will be something like:
```
docker cp buildingsyncwebsite_web_1:/srv/selection-tool/bsyncviewer/lib/bedes/v2.5/schema2.5.0 .
docker cp buildingsync-website-web-1:/srv/buildingsync-website/bsyncviewer/lib/bedes/v2.5/schema2.5.0 .
```
1. Review these mapping files and make changes as needed. Commit and push the files to the BuildingSync-website repository (ideally a branch).
Expand All @@ -283,14 +283,15 @@ Admin interface is available at `/admin`
Follow these steps to add a new schema version to the selection tool:
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.
2. Update the versions in the DEFAULT_SCHEMA_VERSION in the dev.py, gh_actions.py, and docker.py with the latest release.
3. Convert existing use cases schematron files to the new schema. Add the new use cases.
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.
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.
2. Convert existing use cases schematron files to the new schema. Add the new use cases.
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.
4. Update the versions in the DEFAULT_SCHEMA_VERSION in the dev.py, gh_actions.py, and docker.py with the latest release.
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).
6. Test the validator with a local new XML example file.
7. Reparse BEDES terms to map them to the new schema following the steps in the BEDES section above.
8. Deploy website on production
7. Create PR and merge with the changes.
8. Reparse BEDES terms to map them to the new schema following the steps in the BEDES section above.
9. Deploy website on production.
### Adding Examples from the TestSuite repo
Expand Down
17,387 changes: 17,387 additions & 0 deletions bsyncviewer/lib/buildingsync_schemas/BuildingSync_v2.6.0.xsd
View file

Large diffs are not rendered by default.

642 changes: 642 additions & 0 deletions bsyncviewer/lib/validator/examples/schema2.6.0/BETTER_SampleCourthouse.xml
View file

Large diffs are not rendered by default.

514 changes: 514 additions & 0 deletions bsyncviewer/lib/validator/examples/schema2.6.0/BETTER_SampleOffice.xml
View file

Large diffs are not rendered by default.

168 changes: 168 additions & 0 deletions bsyncviewer/lib/validator/examples/schema2.6.0/Example – A Valid Schema.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,168 @@
<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">
<auc:Facilities>
<auc:Facility ID="Facility1">
<auc:Sites>
<auc:Site ID="Site1">
<auc:PremisesIdentifiers>
<auc:PremisesIdentifier>
<auc:IdentifierLabel>Custom</auc:IdentifierLabel>
<auc:IdentifierCustomName>Tax Lot</auc:IdentifierCustomName>
<auc:IdentifierValue>001</auc:IdentifierValue>
</auc:PremisesIdentifier>
<auc:PremisesIdentifier>
<auc:IdentifierLabel>Custom</auc:IdentifierLabel>
<auc:IdentifierCustomName>Borough</auc:IdentifierCustomName>
<auc:IdentifierValue>Brooklyn</auc:IdentifierValue>
</auc:PremisesIdentifier>
<auc:PremisesIdentifier>
<auc:IdentifierLabel>Custom</auc:IdentifierLabel>
<auc:IdentifierCustomName>Tax Block</auc:IdentifierCustomName>
<auc:IdentifierValue>001</auc:IdentifierValue>
</auc:PremisesIdentifier>
</auc:PremisesIdentifiers>
<auc:Address>
<auc:City>New York</auc:City>
<auc:State>NY</auc:State>
</auc:Address>
<auc:Buildings>
<auc:Building ID="Building001">
<auc:PremisesName>Building 001</auc:PremisesName>
<auc:PremisesNotes/>
<auc:PremisesIdentifiers>
<auc:PremisesIdentifier>
<auc:IdentifierLabel>Custom</auc:IdentifierLabel>
<auc:IdentifierCustomName>Custom ID 1</auc:IdentifierCustomName>
<auc:IdentifierValue>001</auc:IdentifierValue>
</auc:PremisesIdentifier>
</auc:PremisesIdentifiers>
<auc:Address>
<auc:StreetAddressDetail>
<auc:Simplified>
<auc:StreetAddress>123 Main St</auc:StreetAddress>
</auc:Simplified>
</auc:StreetAddressDetail>
<auc:City>New York</auc:City>
<auc:State>NY</auc:State>
<auc:PostalCode>11520</auc:PostalCode>
</auc:Address>
<auc:FloorAreas>
<auc:FloorArea>
<auc:FloorAreaType>Gross</auc:FloorAreaType>
<auc:FloorAreaValue>75000</auc:FloorAreaValue>
</auc:FloorArea>
<auc:FloorArea>
<auc:FloorAreaType>Heated and Cooled</auc:FloorAreaType>
<auc:FloorAreaValue>75000</auc:FloorAreaValue>
</auc:FloorArea>
<auc:FloorArea>
<auc:FloorAreaType>Footprint</auc:FloorAreaType>
<auc:FloorAreaValue>80000</auc:FloorAreaValue>
</auc:FloorArea>
</auc:FloorAreas>
<auc:AspectRatio>3.6732677131179763</auc:AspectRatio>
<auc:Perimeter>1350</auc:Perimeter>
<auc:YearOfConstruction>1960</auc:YearOfConstruction>
<auc:YearOfLastMajorRemodel>2008</auc:YearOfLastMajorRemodel>
<auc:Sections>
<auc:Section ID="Default_Subsection">
<auc:SectionType>Whole building</auc:SectionType>
<auc:OccupancyClassification>Retail</auc:OccupancyClassification>
<auc:TypicalOccupantUsages>
<auc:TypicalOccupantUsage>
<auc:TypicalOccupantUsageValue>40.0</auc:TypicalOccupantUsageValue>
<auc:TypicalOccupantUsageUnits>Hours per week</auc:TypicalOccupantUsageUnits>
</auc:TypicalOccupantUsage>
<auc:TypicalOccupantUsage>
<auc:TypicalOccupantUsageValue>50.0</auc:TypicalOccupantUsageValue>
<auc:TypicalOccupantUsageUnits>Weeks per year</auc:TypicalOccupantUsageUnits>
</auc:TypicalOccupantUsage>
</auc:TypicalOccupantUsages>
<auc:FloorAreas>
<auc:FloorArea>
<auc:FloorAreaType>Gross</auc:FloorAreaType>
<auc:FloorAreaValue>69452</auc:FloorAreaValue>
</auc:FloorArea>
<auc:FloorArea>
<auc:FloorAreaType>Tenant</auc:FloorAreaType>
<auc:FloorAreaValue>69452</auc:FloorAreaValue>
</auc:FloorArea>
<auc:FloorArea>
<auc:FloorAreaType>Common</auc:FloorAreaType>
<auc:FloorAreaValue>0.0</auc:FloorAreaValue>
</auc:FloorArea>
</auc:FloorAreas>
</auc:Section>
</auc:Sections>
</auc:Building>
</auc:Buildings>
</auc:Site>
</auc:Sites>
<auc:Measures>
<auc:Measure ID="Measure1">
<auc:SystemCategoryAffected>Lighting</auc:SystemCategoryAffected>
<auc:LinkedPremises>
<auc:Building>
<auc:LinkedBuildingID IDref="Building001"/>
</auc:Building>
</auc:LinkedPremises>
<auc:TechnologyCategories>
<auc:TechnologyCategory>
<auc:LightingImprovements>
<auc:MeasureName>Retrofit with light emitting diode technologies</auc:MeasureName>
</auc:LightingImprovements>
</auc:TechnologyCategory>
</auc:TechnologyCategories>
<auc:MeasureScaleOfApplication>Entire building</auc:MeasureScaleOfApplication>
<auc:LongDescription>Retrofit with light emitting diode technologies</auc:LongDescription>
<auc:MVCost>0</auc:MVCost>
<auc:UsefulLife>12</auc:UsefulLife>
<auc:MeasureTotalFirstCost>267390.2</auc:MeasureTotalFirstCost>
<auc:MeasureInstallationCost>0</auc:MeasureInstallationCost>
<auc:MeasureMaterialCost>0</auc:MeasureMaterialCost>
<auc:Recommended>true</auc:Recommended>
<auc:ImplementationStatus>Proposed</auc:ImplementationStatus>
<auc:UserDefinedFields>
<auc:UserDefinedField>
<auc:FieldName>Rebate Available</auc:FieldName>
<auc:FieldValue>true</auc:FieldValue>
</auc:UserDefinedField>
</auc:UserDefinedFields>
</auc:Measure>
</auc:Measures>
<auc:Reports>
<auc:Report ID="Report1">
<auc:Scenarios>
<auc:Scenario ID="Baseline">
<auc:ScenarioName>Baseline</auc:ScenarioName>
<auc:ScenarioType>
<auc:PackageOfMeasures ID="Package-Baseline">
</auc:PackageOfMeasures>
</auc:ScenarioType>
</auc:Scenario>
<auc:Scenario ID="Scenario1">
<auc:ScenarioName>LED Only</auc:ScenarioName>
<auc:ScenarioType>
<auc:PackageOfMeasures ID="Package-Scenario1">
<auc:MeasureIDs>
<auc:MeasureID IDref="Measure1"/>
</auc:MeasureIDs>
</auc:PackageOfMeasures>
</auc:ScenarioType>
<auc:LinkedPremises>
<auc:Building>
<auc:LinkedBuildingID IDref="Building001"/>
</auc:Building>
</auc:LinkedPremises>
<auc:UserDefinedFields>
<auc:UserDefinedField>
<auc:FieldName>Recommended Resource Savings Category</auc:FieldName>
<auc:FieldValue>Potential Capital Recommendations</auc:FieldValue>
</auc:UserDefinedField>
</auc:UserDefinedFields>
</auc:Scenario>
</auc:Scenarios>
</auc:Report>
</auc:Reports>
</auc:Facility>
</auc:Facilities>
</auc:BuildingSync>
Loading

0 comments on commit 219ac85

Please sign in to comment.