Package 'destep'

Title: A toolkit to convert 'DeST' models to 'EnergyPlus' models
Description: A toolkit to convert 'DeST' models to 'EnergyPlus' models.
Authors: Hongyuan Jia [aut, cre]
Maintainer: Hongyuan Jia <[email protected]>
License: MIT + file LICENSE
Version: 0.0.0.9000
Built: 2025-02-14 03:56:18 UTC
Source: https://github.com/hongyuanjia/destep

Help Index


Download a typical building model from the DeST website

Description

Download a typical building model from the DeST website

Usage

download_dest_model(building_type, location, year, dir = ".")

Arguments

building_type

[character] Building type to download.

location

[character] Location of the building.

year

[integer] Year of the building model.

dir

[string] Directory to save the file. Default is the current workding directory.

Details

The downloaded ⁠7z⁠ file will be unachieved using the {archive} package.

Value

[character] Path to the downloaded file.

Note

Information about all available models can be retrieved by sending a GET request to ⁠https://svr.dest.net.cn/api/v1/all_model_names⁠.

Examples

## Not run: 
download_typical_dest("Commerical office A", "Chongqin", 2015)

## End(Not run)

Read tables from a DeST model and convert to SQLite

Description

Read tables from a DeST model and convert to SQLite

Usage

read_dest(accdb, tables = NULL, sqlite = ":memory:", verbose = FALSE)

Arguments

accdb

[string] Path to the DeST model file. Usually a Microsoft Access database file with .accdb extension.

tables

[character] Vector of table names to read from the DeST model. If NULL, which is the default, all tables will be read.

sqlite

[string] Path to the SQLite database file. If ⁠:memory:⁠, which is the default, a temporary in-memory database will be created.

verbose

[logical] Whether to print information about the conversion process. Default is FALSE.

Value

[DBIConnection] A SQLite database connection with all specified tables..

Note

Tables with the same name will be overwritten in the SQLite database.


Convert a DeST model to EnergyPlus model

Description

Convert a DeST model to EnergyPlus model

Usage

to_eplus(dest, ver = "latest", copy = TRUE)

Arguments

dest

A [string or DBIConnection] path to a DeST model file or a DBIConnection object.

ver

[string] A character string specifying the EnergyPlus version. It can be "latest", which is the default, to indicate using the latest EnergyPlus version supported by the {eplusr} package.

copy

[logical] Whether to copy the input DeST database to a temporary SQLite database. Note that if FALSE, the input database will be modified during the conversion. Default is TRUE.

Value

[eplusr::Idf] The converted EnergyPlus model.