0.18 Changelog¶
0.18¶
Released: May 8, 2020schema¶
Updated to schema version 0.2.
References: #6, #63, pull request 65
Updated the schema yml schema to require the
schema_version
in schema version 0.2. Please refer to the migration document for 0.18 for additional details.References: #6, #63, pull request 65
Updated the schema yml schema to require the
sampling_algorithm
key in thebaseline
section of the configuration yaml to be set. The schema validator will only accept the stringsprecomputed
,quota
(the default residential configuration) andsobol
which at present only has been tested for commercial.References: #6, #63, pull request 65
Added a new validator function
validate_precomputed_sample
to allow for enforcing the existence of theprecomputed_sample
file and ensuring that the file hasn_datapoints
number of enteries. The function isvalidate_precomputed_sample()
.References: pull request 65
Added nor in the schema validator function
validate_xor_schema_keys
to allow for enforcing dual existence of theprecomputed_sample
andsampling_algotithm: precomputed
keys in the configuration sample. The function is now calledvalidate_xor_nor_schema_keys()
.References: pull request 65
Updated the schema validator function
validate_misc_constraints
to ensure that resampling will not be allowed when using thedownselect
functionality if the precomputed sampler is being used.References: pull request 65
comstock¶
ComStock capabilities have been merged into buildstockbatch.
References: #63, pull request 65
Added option to activate custom gems in the singularity container in eagle-based simulations by setting the
custom_gem
key in thebaseline
section of the configuration yaml toTrue
. This is implemented via thebundle
andbundle_path
options in the OpenStudio CLI. Seerun_building()
for additional implementation details.References: pull request 65
Added
CommercialSobolSingularitySampler
andCommercialSobolDockerSampler
.References: pull request 65
Added
CommercialDefaultWorkflowGenerator
References: pull request 65
sampler¶
Implemented a
PrecomputedSampler
class which inherits from theBuildStockSampler
class and replaces the previous workaround inBuildStockBatchBase
. To activate this sampler set thesampling_algorithm
key in thebaseline
section of the configuration yaml toprecomputed
and add in a keyprecomputed_sample
to thebaseline
section of the configuration yaml specifying the absolute path to the buildstock CSV file to use. The methodrun_sampling()
no longer contains any special logic and fully delegates the sampler classes.References: #30