Skip to content

Update notebook examples #531

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JieXiong9119 merged 1 commit into from
Oct 15, 2025
Merged

Update notebook examples #531

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 21 additions & 21 deletions docs/notebooks/bsync_examples/Small-Office-Level-1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -867,22 +867,22 @@ elec_ru += bsync.AnnualPeakNativeUnits(21.12) # kW as specified above
elec_ru += bsync.AnnualPeakConsistentUnits(21.12) # already in kW, same as above
elec_ru += bsync.AnnualFuelCost(5304.) # $28 monthly + $0.0725/kwh per https://missoulaelectric.com/member-care/billing-payment/rates/

# create a resource use for greenhouse gas emissions, units of MtCO2e, all end uses
ghg_linked_ids = bsync.EmissionsLinkedTimeSeriesIDs()
for month in range(1,13):
ghg_linked_ids += bsync.EmissionsLinkedTimeSeriesID(IDref=f"TS-ResourceUse-GreenhouseGasEmissions-{month}")


ghg_ru = bsync.ResourceUse(
bsync.Emissions(
bsync.Emission(
bsync.EmissionBoundary("Indirect"),
bsync.EmissionsType("CO2e"),
bsync.GHGEmissions(25000.0),
ghg_linked_ids
)
)
)
# # create a resource use for greenhouse gas emissions, units of MtCO2e, all end uses
# ghg_linked_ids = bsync.EmissionsLinkedTimeSeriesIDs()
# for month in range(1,13):
# ghg_linked_ids += bsync.EmissionsLinkedTimeSeriesID(IDref=f"TS-ResourceUse-GreenhouseGasEmissions-{month}")


# ghg_ru = bsync.ResourceUse(
# bsync.Emissions(
# bsync.Emission(
# bsync.EmissionBoundary("Indirect"),
# bsync.EmissionsType("CO2e"),
# bsync.GHGEmissions(25000.0),
# ghg_linked_ids
# )
# )
# )

# create a resource use for natural gas, units of MMBtu, all end uses
# additional connect it up to the utility
Expand All @@ -903,12 +903,12 @@ ng_ru += bsync.AnnualFuelCost(91.63) # ~ $5.50/1000ft3 NG per https://naturalgas

# add these to the ResourceUses parent element
all_ru += elec_ru
all_ru += ghg_ru
# all_ru += ghg_ru
all_ru += ng_ru

# we can still add information to the child elements
elec_ru["ID"] = "ResourceUse-Electricity"
ghg_ru["ID"] = "ResourceUse-GreenhouseGasEmissions"
# ghg_ru["ID"] = "ResourceUse-GreenhouseGasEmissions"
ng_ru["ID"] = "ResourceUse-Natural-gas"

# ResourceUses are child elements of a specific scenario:
Expand Down Expand Up @@ -985,7 +985,7 @@ full_ts_data = bsync.TimeSeriesData()

# usage and peak data
monthly_elec = [6792.89, 5841.75, 6025.19, 4985.3, 5184.04, 5358.55, 5755.67, 5981.78, 5401.94, 5225.84, 5672.15, 6291.63]
monthly_ghg = [250.0, 240.0, 260.0, 250.0, 260.0, 230.0, 280.0, 270.0, 260.0, 250.0, 240.0, 250.0]
# monthly_ghg = [250.0, 240.0, 260.0, 250.0, 260.0, 230.0, 280.0, 270.0, 260.0, 250.0, 240.0, 250.0]
monthly_ng = [5.7, 4.01, 0.58, 0.4, 0.02, 0, 0, 0, 0, 0.01, 0.36, 6.08]
monthly_elec_peak = [15.42, 15.5, 16.25, 16.65, 18.56, 20.01, 20.82, 21.12, 20.42, 20.08, 17.4, 16.3]

Expand Down Expand Up @@ -1040,7 +1040,7 @@ def create_monthly(values, resource_use_id, start_year, tsrq="Energy", rt="Total
return monthly

elec_ts = create_monthly(monthly_elec, elec_ru["ID"], 2019)
ghg_ts = create_monthly(monthly_ghg, ghg_ru["ID"], 2019, tsrq="Greenhouse Gas Emissions")
# ghg_ts = create_monthly(monthly_ghg, ghg_ru["ID"], 2019, tsrq="Greenhouse Gas Emissions")
ng_ts = create_monthly(monthly_ng, ng_ru["ID"], 2019)
elec_peak_ts = create_monthly(monthly_elec_peak, elec_ru["ID"], 2019, "Power", "Peak")

Expand All @@ -1052,7 +1052,7 @@ def add_to_full(months, full):
full += month

add_to_full(elec_ts, full_ts_data)
add_to_full(ghg_ts, full_ts_data)
# add_to_full(ghg_ts, full_ts_data)
add_to_full(ng_ts, full_ts_data)
add_to_full(elec_peak_ts, full_ts_data)
add_to_full(elec_cost_ts, full_ts_data)
Expand Down
131 changes: 0 additions & 131 deletions docs/notebooks/bsync_examples/example-smalloffice-level1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,29 +231,6 @@
<UtilityID IDref="Utility-Electric"/>
</UtilityIDs>
</ResourceUse>
<ResourceUse ID="ResourceUse-GreenhouseGasEmissions">
<Emissions>
<Emission>
<EmissionBoundary>Indirect</EmissionBoundary>
<EmissionsType>CO2e</EmissionsType>
<GHGEmissions>25000.000000</GHGEmissions>
<EmissionsLinkedTimeSeriesIDs>
<EmissionsLinkedTimeSeriesID IDref="TS-ResourceUse-GreenhouseGasEmissions-1"/>
<EmissionsLinkedTimeSeriesID IDref="TS-ResourceUse-GreenhouseGasEmissions-2"/>
<EmissionsLinkedTimeSeriesID IDref="TS-ResourceUse-GreenhouseGasEmissions-3"/>
<EmissionsLinkedTimeSeriesID IDref="TS-ResourceUse-GreenhouseGasEmissions-4"/>
<EmissionsLinkedTimeSeriesID IDref="TS-ResourceUse-GreenhouseGasEmissions-5"/>
<EmissionsLinkedTimeSeriesID IDref="TS-ResourceUse-GreenhouseGasEmissions-6"/>
<EmissionsLinkedTimeSeriesID IDref="TS-ResourceUse-GreenhouseGasEmissions-7"/>
<EmissionsLinkedTimeSeriesID IDref="TS-ResourceUse-GreenhouseGasEmissions-8"/>
<EmissionsLinkedTimeSeriesID IDref="TS-ResourceUse-GreenhouseGasEmissions-9"/>
<EmissionsLinkedTimeSeriesID IDref="TS-ResourceUse-GreenhouseGasEmissions-10"/>
<EmissionsLinkedTimeSeriesID IDref="TS-ResourceUse-GreenhouseGasEmissions-11"/>
<EmissionsLinkedTimeSeriesID IDref="TS-ResourceUse-GreenhouseGasEmissions-12"/>
</EmissionsLinkedTimeSeriesIDs>
</Emission>
</Emissions>
</ResourceUse>
<ResourceUse ID="ResourceUse-Natural-gas">
<EnergyResource>Natural gas</EnergyResource>
<ResourceUseNotes>No irregularities in monthly energy consumption found.</ResourceUseNotes>
Expand Down Expand Up @@ -390,114 +367,6 @@
<IntervalReading>6291.630000</IntervalReading>
<ResourceUseID IDref="ResourceUse-Electricity"/>
</TimeSeries>
<TimeSeries ID="TS-ResourceUse-GreenhouseGasEmissions-1">
<ReadingType>Total</ReadingType>
<TimeSeriesReadingQuantity>Greenhouse Gas Emissions</TimeSeriesReadingQuantity>
<StartTimestamp>2019-01-01T00:00:00</StartTimestamp>
<EndTimestamp>2019-02-01T00:00:00</EndTimestamp>
<IntervalFrequency>Month</IntervalFrequency>
<IntervalReading>250.000000</IntervalReading>
<ResourceUseID IDref="ResourceUse-GreenhouseGasEmissions"/>
</TimeSeries>
<TimeSeries ID="TS-ResourceUse-GreenhouseGasEmissions-2">
<ReadingType>Total</ReadingType>
<TimeSeriesReadingQuantity>Greenhouse Gas Emissions</TimeSeriesReadingQuantity>
<StartTimestamp>2019-02-01T00:00:00</StartTimestamp>
<EndTimestamp>2019-03-01T00:00:00</EndTimestamp>
<IntervalFrequency>Month</IntervalFrequency>
<IntervalReading>240.000000</IntervalReading>
<ResourceUseID IDref="ResourceUse-GreenhouseGasEmissions"/>
</TimeSeries>
<TimeSeries ID="TS-ResourceUse-GreenhouseGasEmissions-3">
<ReadingType>Total</ReadingType>
<TimeSeriesReadingQuantity>Greenhouse Gas Emissions</TimeSeriesReadingQuantity>
<StartTimestamp>2019-03-01T00:00:00</StartTimestamp>
<EndTimestamp>2019-04-01T00:00:00</EndTimestamp>
<IntervalFrequency>Month</IntervalFrequency>
<IntervalReading>260.000000</IntervalReading>
<ResourceUseID IDref="ResourceUse-GreenhouseGasEmissions"/>
</TimeSeries>
<TimeSeries ID="TS-ResourceUse-GreenhouseGasEmissions-4">
<ReadingType>Total</ReadingType>
<TimeSeriesReadingQuantity>Greenhouse Gas Emissions</TimeSeriesReadingQuantity>
<StartTimestamp>2019-04-01T00:00:00</StartTimestamp>
<EndTimestamp>2019-05-01T00:00:00</EndTimestamp>
<IntervalFrequency>Month</IntervalFrequency>
<IntervalReading>250.000000</IntervalReading>
<ResourceUseID IDref="ResourceUse-GreenhouseGasEmissions"/>
</TimeSeries>
<TimeSeries ID="TS-ResourceUse-GreenhouseGasEmissions-5">
<ReadingType>Total</ReadingType>
<TimeSeriesReadingQuantity>Greenhouse Gas Emissions</TimeSeriesReadingQuantity>
<StartTimestamp>2019-05-01T00:00:00</StartTimestamp>
<EndTimestamp>2019-06-01T00:00:00</EndTimestamp>
<IntervalFrequency>Month</IntervalFrequency>
<IntervalReading>260.000000</IntervalReading>
<ResourceUseID IDref="ResourceUse-GreenhouseGasEmissions"/>
</TimeSeries>
<TimeSeries ID="TS-ResourceUse-GreenhouseGasEmissions-6">
<ReadingType>Total</ReadingType>
<TimeSeriesReadingQuantity>Greenhouse Gas Emissions</TimeSeriesReadingQuantity>
<StartTimestamp>2019-06-01T00:00:00</StartTimestamp>
<EndTimestamp>2019-07-01T00:00:00</EndTimestamp>
<IntervalFrequency>Month</IntervalFrequency>
<IntervalReading>230.000000</IntervalReading>
<ResourceUseID IDref="ResourceUse-GreenhouseGasEmissions"/>
</TimeSeries>
<TimeSeries ID="TS-ResourceUse-GreenhouseGasEmissions-7">
<ReadingType>Total</ReadingType>
<TimeSeriesReadingQuantity>Greenhouse Gas Emissions</TimeSeriesReadingQuantity>
<StartTimestamp>2019-07-01T00:00:00</StartTimestamp>
<EndTimestamp>2019-08-01T00:00:00</EndTimestamp>
<IntervalFrequency>Month</IntervalFrequency>
<IntervalReading>280.000000</IntervalReading>
<ResourceUseID IDref="ResourceUse-GreenhouseGasEmissions"/>
</TimeSeries>
<TimeSeries ID="TS-ResourceUse-GreenhouseGasEmissions-8">
<ReadingType>Total</ReadingType>
<TimeSeriesReadingQuantity>Greenhouse Gas Emissions</TimeSeriesReadingQuantity>
<StartTimestamp>2019-08-01T00:00:00</StartTimestamp>
<EndTimestamp>2019-09-01T00:00:00</EndTimestamp>
<IntervalFrequency>Month</IntervalFrequency>
<IntervalReading>270.000000</IntervalReading>
<ResourceUseID IDref="ResourceUse-GreenhouseGasEmissions"/>
</TimeSeries>
<TimeSeries ID="TS-ResourceUse-GreenhouseGasEmissions-9">
<ReadingType>Total</ReadingType>
<TimeSeriesReadingQuantity>Greenhouse Gas Emissions</TimeSeriesReadingQuantity>
<StartTimestamp>2019-09-01T00:00:00</StartTimestamp>
<EndTimestamp>2019-10-01T00:00:00</EndTimestamp>
<IntervalFrequency>Month</IntervalFrequency>
<IntervalReading>260.000000</IntervalReading>
<ResourceUseID IDref="ResourceUse-GreenhouseGasEmissions"/>
</TimeSeries>
<TimeSeries ID="TS-ResourceUse-GreenhouseGasEmissions-10">
<ReadingType>Total</ReadingType>
<TimeSeriesReadingQuantity>Greenhouse Gas Emissions</TimeSeriesReadingQuantity>
<StartTimestamp>2019-10-01T00:00:00</StartTimestamp>
<EndTimestamp>2019-11-01T00:00:00</EndTimestamp>
<IntervalFrequency>Month</IntervalFrequency>
<IntervalReading>250.000000</IntervalReading>
<ResourceUseID IDref="ResourceUse-GreenhouseGasEmissions"/>
</TimeSeries>
<TimeSeries ID="TS-ResourceUse-GreenhouseGasEmissions-11">
<ReadingType>Total</ReadingType>
<TimeSeriesReadingQuantity>Greenhouse Gas Emissions</TimeSeriesReadingQuantity>
<StartTimestamp>2019-11-01T00:00:00</StartTimestamp>
<EndTimestamp>2019-12-01T00:00:00</EndTimestamp>
<IntervalFrequency>Month</IntervalFrequency>
<IntervalReading>240.000000</IntervalReading>
<ResourceUseID IDref="ResourceUse-GreenhouseGasEmissions"/>
</TimeSeries>
<TimeSeries ID="TS-ResourceUse-GreenhouseGasEmissions-12">
<ReadingType>Total</ReadingType>
<TimeSeriesReadingQuantity>Greenhouse Gas Emissions</TimeSeriesReadingQuantity>
<StartTimestamp>2019-12-01T00:00:00</StartTimestamp>
<EndTimestamp>2020-01-01T00:00:00</EndTimestamp>
<IntervalFrequency>Month</IntervalFrequency>
<IntervalReading>250.000000</IntervalReading>
<ResourceUseID IDref="ResourceUse-GreenhouseGasEmissions"/>
</TimeSeries>
<TimeSeries ID="TS-ResourceUse-Natural-gas-Energy-1">
<ReadingType>Total</ReadingType>
<TimeSeriesReadingQuantity>Energy</TimeSeriesReadingQuantity>
Expand Down
8 changes: 7 additions & 1 deletion docs/notebooks/example-with-emissions.xml → ...bsync_examples/example-with-emissions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<BuildingSync xmlns="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 ../../BuildingSync.xsd"
xsi:schemaLocation="http://buildingsync.net/schemas/bedes-auc/2019 ../../../BuildingSync.xsd"
version="2.7.0">
<Facilities>
<Facility ID="Facility-1">
Expand Down Expand Up @@ -1416,6 +1416,12 @@
</TimeSeriesData>
</Scenario>
</Scenarios>
<AuditorContactID IDref="Contact-Auditor"/>
<LinkedPremisesOrSystem>
<Building>
<LinkedBuildingID IDref="Building-Small-Office-Prototype"/>
</Building>
</LinkedPremisesOrSystem>
</Report>
</Reports>
<Contacts>
Expand Down