0.18 Changelog

0.18

Released: May 8, 2020

schema

  • [schema] [changed]

    Updated to schema version 0.2.

    References: #6, #63, pull request 65

  • [schema] [changed]

    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

  • [schema] [changed] [sampler]

    Updated the schema yml schema to require the sampling_algorithm key in the baseline section of the configuration yaml to be set. The schema validator will only accept the strings precomputed, quota (the default residential configuration) and sobol which at present only has been tested for commercial.

    References: #6, #63, pull request 65

  • [schema] [change]

    Added a new validator function validate_precomputed_sample to allow for enforcing the existence of the precomputed_sample file and ensuring that the file has n_datapoints number of enteries. The function is validate_precomputed_sample().

    References: pull request 65

  • [schema] [change] [sampler]

    Added nor in the schema validator function validate_xor_schema_keys to allow for enforcing dual existence of the precomputed_sample and sampling_algotithm: precomputed keys in the configuration sample. The function is now called validate_xor_nor_schema_keys().

    References: pull request 65

  • [schema] [change] [sampler]

    Updated the schema validator function validate_misc_constraints to ensure that resampling will not be allowed when using the downselect functionality if the precomputed sampler is being used.

    References: pull request 65

comstock

  • [comstock] [feature]

    ComStock capabilities have been merged into buildstockbatch.

    References: #63, pull request 65

  • [comstock] [feature] [eagle] [schema]

    Added option to activate custom gems in the singularity container in eagle-based simulations by setting the custom_gem key in the baseline section of the configuration yaml to True. This is implemented via the bundle and bundle_path options in the OpenStudio CLI. See run_building for additional implementation details.

    References: pull request 65

  • [comstock] [feature] [sampler]

    Added CommercialSobolSingularitySampler and CommercialSobolDockerSampler.

    References: pull request 65

  • [comstock] [feature] [workflow]

    Added CommercialDefaultWorkflowGenerator

    References: pull request 65

sampler

  • [sampler] [changed] [schema]

    Implemented a PrecomputedSampler class which inherits from the BuildStockSampler class and replaces the previous workaround in BuildStockBatchBase. To activate this sampler set the sampling_algorithm key in the baseline section of the configuration yaml to precomputed and add in a key precomputed_sample to the baseline section of the configuration yaml specifying the absolute path to the buildstock CSV file to use. The method run_sampling() no longer contains any special logic and fully delegates the sampler classes.

    References: #30