mtx

ladybug-comfort mtx

Commands for running matrices of conditions through comfort models.

ladybug-comfort mtx [OPTIONS] COMMAND [ARGS]...

adaptive

Get CSV files with matrices of Adaptive comfort from matrices of Adaptive inputs.

Args:

temperature_mtx: Path to a CSV file with with a matrix of temperature

values in Celsius.

prevail_temp: Path to a CSV file with with a list of prevailing outdoor

temperatures in a single row (one temperautre per column).

ladybug-comfort mtx adaptive [OPTIONS] TEMPERATURE_MTX PREVAIL_TEMP

Options

-rm, --rad-temperature-mtx <rad_temperature_mtx>

Path to a CSV file with with a matrix of MRT values. If unspecified, the radiant and the air temperature will be assumed to be the same.

-dm, --rad-delta-mtx <rad_delta_mtx>

Path to a CSV file with with a matrix of MRT deltas to be added to the base MRT values. This can be used to account for shortwave solar.

-vm, --air-speed-mtx <air_speed_mtx>

Path to a CSV file with with a matrix of air speed values in m/s. If specified, this overrides both the –air-speed-json and the –air-speed inputs.

-vj, --air-speed-json <air_speed_json>

Path to a JSON file conaining a simplified set of air speed values for each row of the matrix in m/s. If specified, this overrides the the –air-speed input.

-v, --air-speed <air_speed>

A single number for air speed in m/s or the path to a CSV file containing a single number per row and a number of rows that aligns with the width of the matrix. This can also be a string of a JSON array with that aligns with the matrix width, though this is only recommended for narrow matrices. If unspecified or “None”, 0.1 m/s will be used.

-cp, --comfort-par <comfort_par>

A AdaptiveParameter string to customize the assumptions of the Adaptive model.

-f, --folder <folder>

Folder into which the result CSV files will be written. If None, files will be written to a “thermal_mtx” sub-folder insame directory as the temperature-mtx.

-log, --log-file <log_file>

Optional log file to output the paths to the generated CSV files. By default this will be printed out to stdout

Default

-

Arguments

TEMPERATURE_MTX

Required argument

PREVAIL_TEMP

Required argument

pmv

Get CSV files with matrices of PMV comfort from matrices of PMV inputs.

Args:

temperature_mtx: Path to a CSV file with with a matrix of temperature

values in Celsius.

rel_humidity_mtx: Path to a CSV file with with a matrix of relative humidity

values in Percent.

ladybug-comfort mtx pmv [OPTIONS] TEMPERATURE_MTX REL_HUMIDITY_MTX

Options

-rm, --rad-temperature-mtx <rad_temperature_mtx>

Path to a CSV file with with a matrix of MRT values. If unspecified, the radiant and the air temperature will be assumed to be the same.

-dm, --rad-delta-mtx <rad_delta_mtx>

Path to a CSV file with with a matrix of MRT deltas to be added to the base MRT values. This can be used to account for shortwave solar.

-vm, --air-speed-mtx <air_speed_mtx>

Path to a CSV file with with a matrix of air speed values in m/s. If specified, this overrides both the –air-speed-json and the –air-speed inputs.

-vj, --air-speed-json <air_speed_json>

Path to a JSON file conaining a simplified set of air speed values for each row of the matrix in m/s. If specified, this overrides the the –air-speed input.

-v, --air-speed <air_speed>

A single number for air speed in m/s or the path to a CSV file containing a single number per row and a number of rows that aligns with the width of the matrix. This can also be a string of a JSON array with that aligns with the matrix width, though this is only recommended for narrow matrices. If unspecified or “None”, 0.1 m/s will be used.

-m, --met-rate <met_rate>

A single number for metabolic rate in met or the path to a CSV file containing a single number per row and a number of rows that aligns with the width of the matrix. This can also be a string of a JSON array with that aligns with the matrix width, though this is only recommended for narrow matrices. If unspecified or “None”, 1.1 met will be used.

-c, --clo-value <clo_value>

A single number for clothing level in clo or the path to a CSV file containing a single number per row and a number of rows that aligns with the width of the matrix. This can also be a string of a JSON array with that aligns with the matrix width, though this is only recommended for narrow matrices. If unspecified or “None”, 0.7 clo will be used.

--write-op-map, -set, --write-set-map

Flag to note whether the output temperature CSV should record Operative Temperature or Standard Effective Temperature (SET). SET is relatively intense to compute and so only recording Operative Temperature can greatly reduce run time, particularly when air speeds are low. However, SET accounts for all 6 PMV model inputs and so is a more representative “feels-like” temperature for the PMV model.

-cp, --comfort-par <comfort_par>

A PMVParameter string to customize the assumptions of the PMV model.

-f, --folder <folder>

Folder into which the result CSV files will be written. If None, files will be written to a “thermal_mtx” sub-folder insame directory as the temperature-mtx.

-log, --log-file <log_file>

Optional log file to output the paths to the generated CSV files. By default this will be printed out to stdout

Default

-

Arguments

TEMPERATURE_MTX

Required argument

REL_HUMIDITY_MTX

Required argument

utci

Get CSV files with matrices of UTCI comfort from matrices of UTCI inputs.

Args:

temperature_mtx: Path to a CSV file with with a matrix of temperature

values in Celsius.

rel_humidity_mtx: Path to a CSV file with with a matrix of relative humidity

values in Percent.

ladybug-comfort mtx utci [OPTIONS] TEMPERATURE_MTX REL_HUMIDITY_MTX

Options

-rm, --rad-temperature-mtx <rad_temperature_mtx>

Path to a CSV file with with a matrix of MRT values. If unspecified, the radiant and the air temperature will be assumed to be the same.

-dm, --rad-delta-mtx <rad_delta_mtx>

Path to a CSV file with with a matrix of MRT deltas to be added to the base MRT values. This can be used to account for shortwave solar.

-vm, --air-speed-mtx <air_speed_mtx>

Path to a CSV file with with a matrix of air speed values in m/s. Note that these values are not meteorological and should be AT OCCUPANT LEVEL. If specified, this overrides both the –wind-speed-json and the –wind-speed inputs.

-vj, --wind-speed-json <wind_speed_json>

Path to a JSON file conaining a set of meteorological wind speed values for each row of the matrix in m/s. If specified, this overrides the the –wind-speed input.

-v, --wind-speed <wind_speed>

A single number for meteorological wind speed in m/s or the path to a CSV file containing a single number per row and a number of rows that aligns with the width of the matrix. This can also be a string of a JSON array with that aligns with the matrix width, though this is only recommended for narrow matrices. If unspecified or “None”, 0.5 m/s will be used.

-cp, --comfort-par <comfort_par>

A UTCIParameter string to customize the assumptions of the UTCI model.

-f, --folder <folder>

Folder into which the result CSV files will be written. If None, files will be written to a “thermal_mtx” sub-folder insame directory as the temperature-mtx.

-log, --log-file <log_file>

Optional log file to output the paths to the generated CSV files. By default this will be printed out to stdout

Default

-

Arguments

TEMPERATURE_MTX

Required argument

REL_HUMIDITY_MTX

Required argument