cea package

Subpackages

Submodules

cea.globalvar module

Global variables - this object contains context information and is expected to be refactored away in future.

class cea.globalvar.GlobalVariables[source]

Bases: object

is_heating_season(timestep)[source]
log(msg, **kwargs)[source]
report(tsd, output_folder, basename)[source]

Use vars to fill worksheets in an excel file $destination_template based on the template. The template references self.report_variables. The destination_template may contain date format codes that will be updated with the current datetime.

cea.inputlocator module

inputlocator.py - locate input files by name based on the reference folder structure.

class cea.inputlocator.InputLocator(scenario_path)[source]

Bases: object

The InputLocator locates files and folders for input to the scripts. This works, because we have a convention for the folder structure of a scenario. It also provides locations of other files, such as those in the databases folder (e.g. archetypes).

get_archetypes_properties()[source]

databases/CH/Archetypes/Archetypes_properties.xlsx path to database of archetypes file Archetypes_properties.xlsx

get_archetypes_schedules()[source]

databases/CH/Archetypes/Archetypes_schedules.xlsx path to database of archetypes file Archetypes_HVAC_properties.xlsx

get_benchmark_plots_file()[source]

scenario/outputs/plots/graphs/Benchmark_scenarios.pdf

get_building_age()[source]

scenario/inputs/building-properties/age.dbf

get_building_architecture()[source]

scenario/inputs/building-properties/architecture.dbf This file is generated by the properties script. This file is used in the embodied energy script (cea/embodied.py) and the demand script (cea/demand_main.py)

get_building_comfort()[source]

scenario/inputs/building-properties/indoor_comfort.dbf

get_building_geometry()[source]

scenario/inputs/building-geometry/zone.shp

get_building_hvac()[source]

scenario/inputs/building-properties/technical_systems.dbf

get_building_internal()[source]

scenario/inputs/building-properties/internal_loads.dbf

get_building_occupancy()[source]

scenario/inputs/building-properties/building_occupancy.dbf

get_building_overrides()[source]

scenario/inputs/building-properties/overrides.csv This file contains overrides to the building properties input files. They are applied after reading those files and are matched by column name.

get_building_supply()[source]

scenario/inputs/building-properties/building_supply.dbf

get_calibration_cluster(sax_name)[source]

scenario/outputs/data/demand/{sax_name}.csv

get_calibration_cluster_opt_checkpoint(generation)[source]

scenario/outputs/data/demand/{sax_name}.csv

get_calibration_clusters_names()[source]

scenario/outputs/data/demand/{sax_name}.csv

get_calibration_folder()[source]

scenario/outputs/data/calibration

get_data_benchmark()[source]

databases/CH/Benchmarks/benchmark_targets.xls

get_data_mobility()[source]

databases/CH/Benchmarks/mobility.xls

get_default_weather()[source]

weather/Zug-2010.epw path to database of archetypes file Archetypes_properties.xlsx

get_demand_measured_file(building_name)[source]

scenario/outputs/data/demand/{building_name}.csv

get_demand_measured_folder()[source]

scenario/outputs/data/demand

get_demand_plots_file(building_name)[source]

scenario/outputs/plots/timeseries/{building_name}.pdf

get_demand_plots_folder()[source]

scenario/outputs/plots/timeseries

get_demand_results_file(building_name)[source]

scenario/outputs/data/demand/{building_name}.csv

get_demand_results_folder()[source]

scenario/outputs/data/demand

get_district()[source]

scenario/inputs/building-geometry/district.shp

get_envelope_systems()[source]

databases/CH/Systems/emission_systems.csv

get_geothermal_potential()[source]

scenario/outputs/data/potentials/geothermal.csv

get_heatmaps_demand_folder()[source]

scenario/outputs/plots/heatmaps

get_heatmaps_emission_folder()[source]

scenario/outputs/plots/heatmaps

get_lca_embodied()[source]

scenario/outputs/data/emissions/Total_LCA_embodied.csv

get_lca_emissions_results_folder()[source]

scenario/outputs/data/emissions

get_lca_mobility()[source]

scenario/outputs/data/emissions/Total_LCA_mobility.csv

get_lca_operation()[source]

scenario/outputs/data/emissions/Total_LCA_operation.csv

get_life_cycle_inventory_supply_systems()[source]

databases/CH/Systems/supply_systems.csv

get_measurements()[source]

scenario/inputs/ Operation pattern for disconnected buildings

get_optimization_clustering_folder()[source]

scenario/outputs/data/optimization/clustering Clustering results for disconnected buildings

get_optimization_disconnected_folder()[source]

scenario/outputs/data/optimization/disconnected Operation pattern for disconnected buildings

get_optimization_disconnected_result_file(building_name)[source]

scenario/outputs/data/optimization/disconnected/DiscOp_${building_name}_result.csv

get_optimization_master_results_folder()[source]

scenario/outputs/data/optimization/master Master checkpoints

get_optimization_network_layout_folder()[source]

scenario/outputs/data/optimization/network/layout Network layout files

get_optimization_network_layout_pipes_file()[source]

scenario/outputs/data/optimization/network/layout/PipesData_DH.csv Network layout files for pipes of district heat networks

get_optimization_network_results_folder()[source]

scenario/outputs/data/optimization/network Network summary results

get_optimization_network_totals_folder()[source]

scenario/outputs/data/optimization/network/totals Total files (inputs to substation + network in master)

get_optimization_plots_folder()[source]

scenario/outputs/plots/graphs/Benchmark_scenarios.pdf

get_optimization_results_folder()[source]

scenario/outputs/data/optimization

get_optimization_slave_results_folder()[source]

scenario/outputs/data/optimization/slave Slave results folder (storage + operation pattern)

get_optimization_substations_folder()[source]

scenario/outputs/data/optimization/substations Substation results for disconnected buildings

get_optimization_substations_results_file(building_name)[source]

scenario/outputs/data/optimization/substations/${building_name}_result.csv

get_optimization_substations_total_file(genome)[source]

scenario/outputs/data/optimization/substations/Total_${genome}.csv

get_potentials_results_folder()[source]

scenario/outputs/data/potentials

get_potentials_solar_folder()[source]

scenario/outputs/data/potentials/solar Contains raw solar files

get_radiation()[source]

scenario/outputs/data/solar-radiation/radiation.csv

get_sensitivity_output(method, samples)[source]

scenario/outputs/data/sensitivity-analysis/sensitivity_${METHOD}_${SAMPLES}.xls

get_sensitivity_plots_file(parameter)[source]

scenario/outputs/plots/sensitivity/${PARAMETER}.pdf

get_sewage_heat_potential()[source]
get_solar_radiation_folder()[source]

scenario/outputs/data/solar-radiation

get_surface_properties()[source]

scenario/outputs/data/solar-radiation/properties_surfaces.csv

get_technical_emission_systems()[source]

databases/CH/Systems/emission_systems.csv

get_temporary_file(filename)[source]

Returns the path to a file in the temporary folder with the name filename

get_temporary_folder()[source]

Temporary folder as returned by tempfile.

get_terrain()[source]

scenario/inputs/topography/terrain.tif

get_timeseries_plots_file(building_name)[source]

scenario/outputs/plots/timeseries/{building_name}.html

get_total_demand()[source]

scenario/outputs/data/demand/Total_demand.csv

get_uncertainty_db()[source]

databases/CH/Uncertainty/uncertainty_distributions.xls

get_weather(name)[source]

weather/{name}.epw

get_weather_names()[source]

Return a list of all installed epw files in the system

Module contents