epw¶
ladybug-comfort epw¶
Commands for running EPW weather data through comfort models.
ladybug-comfort epw [OPTIONS] COMMAND [ARGS]...
air-speed-json¶
Get a JSON of air speeds that can be used as input for the mtx commands.
ladybug-comfort epw air-speed-json [OPTIONS] EPW_FILE ENCLOSURE_INFO
Options
- -m, --multiply-by <multiply_by>¶
A number to denote a factor that EPW wind speeds should be multipled by in order to represent air speeds at ground level.
- Default
0.5
- -i, --indoor-air-speed <indoor_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 length of the –run-period. This can also be a string of a JSON array with that aligns with the –run-period, though this is only recommended for cases of short run periods. If unspecified, 0.1 m/s will be used.
- -o, --outdoor-air-speed <outdoor_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 length of the –run-period. This can also be a string of a JSON array with that aligns with the –run-period, though this is only recommended for cases of short run periods. If unspecified, the EPW wind speed times the –multiply-by will be used.
- -rp, --run-period <run_period>¶
An AnalysisPeriod string to dictate the start and end of the analysis (eg. “6/21 to 9/21 between 8 and 16 @1”). If unspecified, results will be generated for the entire year of the EPW.
- -f, --output-file <output_file>¶
Optional file to output the JSON string. By default, it will be printed to stdout
- Default
-
Arguments
- EPW_FILE¶
Required argument
- ENCLOSURE_INFO¶
Required argument
prevailing¶
Get Adaptive comfort Prevailing Outdoor Temperature from an EPW weather file.
ladybug-comfort epw prevailing [OPTIONS] EPW_FILE
Options
- -cp, --comfort-par <comfort_par>¶
A AdaptiveParameter string to customize the assumptions of the Adaptive model.
- -rp, --run-period <run_period>¶
An AnalysisPeriod string to dictate the start and end of the analysis (eg. “6/21 to 9/21 between 8 and 16 @1”). If unspecified, results will be generated for the entire year of the EPW.
- --csv, -j, --json¶
Flag to note whether the output data should be in CSV or JSON format.
- Default
True
- --rows, -c, --columns¶
Flag to note whether the CSV should be written with rows or columns.
- Default
True
- -f, --output-file <output_file>¶
Optional file to output the CSV or JSON string of the data. By default, it will be printed to stdout
- Default
-
Arguments
- EPW_FILE¶
Required argument
set¶
Get Standard Effective Temperature (SET) values from an EPW weather file.
ladybug-comfort epw set [OPTIONS] EPW_FILE
Options
- --include-wind, -xw, --exclude-wind¶
Flag to note whether to include the EPW wind speed in the calculation.
- Default
True
- --include-sun, -xs, --exclude-sun¶
Flag to note whether to include the mean radiant temperature (MRT) delta from both shortwave solar falling directly on people and long wave radiant exchange with the sky.
- Default
True
- -m, --met-rate <met_rate>¶
A number for metabolic rate in met.
- Default
2.4
- -c, --clo-value <clo_value>¶
A number for clothing level in clo.
- Default
0.7
- -rp, --run-period <run_period>¶
An AnalysisPeriod string to dictate the start and end of the analysis (eg. “6/21 to 9/21 between 8 and 16 @1”). If unspecified, results will be generated for the entire year of the EPW.
- --csv, -j, --json¶
Flag to note whether the output data should be in CSV or JSON format.
- Default
True
- --rows, -c, --columns¶
Flag to note whether the CSV should be written with rows or columns.
- Default
True
- -f, --output-file <output_file>¶
Optional file to output the JSON string of the data collection. By default, it will be printed to stdout
- Default
-
Arguments
- EPW_FILE¶
Required argument
utci¶
Get UTCI values from an EPW weather file.
ladybug-comfort epw utci [OPTIONS] EPW_FILE
Options
- --include-wind, -xw, --exclude-wind¶
Flag to note whether to include the EPW wind speed in the calculation.
- Default
True
- --include-sun, -xs, --exclude-sun¶
Flag to note whether to include the mean radiant temperature (MRT) delta from both shortwave solar falling directly on people and long wave radiant exchange with the sky.
- Default
True
- -rp, --run-period <run_period>¶
An AnalysisPeriod string to dictate the start and end of the analysis (eg. “6/21 to 9/21 between 8 and 16 @1”). If unspecified, results will be generated for the entire year of the EPW.
- --csv, -j, --json¶
Flag to note whether the output data should be in CSV or JSON format.
- Default
True
- --rows, -c, --columns¶
Flag to note whether the CSV should be written with rows or columns.
- Default
True
- -f, --output-file <output_file>¶
Optional file to output the CSV or JSON string of the data. By default, it will be printed to stdout
- Default
-
Arguments
- EPW_FILE¶
Required argument