API reference

• cea package
  • CEAException
  • ConfigError
    • ConfigError.__annotations__
    • ConfigError.rc
  • CustomDatabaseNotFound
    • CustomDatabaseNotFound.__annotations__
    • CustomDatabaseNotFound.rc
  • InvalidOccupancyNameException
    • InvalidOccupancyNameException.__annotations__
    • InvalidOccupancyNameException.rc
  • MissingInputDataException
    • MissingInputDataException.__annotations__
    • MissingInputDataException.rc
  • ScriptNotFoundException
    • ScriptNotFoundException.__annotations__
    • ScriptNotFoundException.rc
  • suppress_3rd_party_debug_loggers()
  • Subpackages
    • cea.analysis package
    • cea.datamanagement package
    • cea.demand package
    • cea.dev package
    • cea.examples package
    • cea.interfaces package
    • cea.optimization package
    • cea.plots package
    • cea.resources package
    • cea.technologies package
    • cea.tests package
    • cea.utilities package
    • cea.workflows package
  • Submodules
  • cea.api module
    • ScriptStatus
    • anthropogenic_heat()
    • archetypes_mapper()
    • bake_pathway_states()
    • batch_process_workflow()
    • build()
    • cea4_format_helper()
    • cea4_migrate()
    • cea4_verify()
    • compile()
    • create_mixed_use_type()
    • create_new_pathway()
    • create_polygon()
    • dashboard()
    • database_helper()
    • dbf_to_csv_to_dbf()
    • decentralized()
    • demand()
    • emissions()
    • excel_to_shapefile()
    • export_results_csv()
    • export_to_rhino_gh()
    • extract_reference_case()
    • final_energy()
    • glossary()
    • graphviz()
    • html()
    • import_from_rhino_gh()
    • list_demand_graphs_fields()
    • multi_criteria_analysis()
    • network_layout()
    • occupancy()
    • optimization_new()
    • pathway_delete_pathway()
    • pathway_delete_state()
    • pathway_events_apply_templates()
    • pathway_intervention_templates_define()
    • pathway_save_yaml()
    • pathway_simulations()
    • pathway_update_building_events()
    • pathway_validate_all_states()
    • pathway_validate_state()
    • photovoltaic()
    • photovoltaic_thermal()
    • plot_comfort_chart()
    • plot_cost_breakdown()
    • plot_cost_sankey()
    • plot_demand()
    • plot_emission_timeline()
    • plot_energy_sankey()
    • plot_final_energy()
    • plot_heat_rejection()
    • plot_ldc_component()
    • plot_lifecycle_emissions()
    • plot_operational_emissions()
    • plot_pareto_front()
    • plot_pathway_emission_timeline()
    • plot_solar()
    • plot_supply_system()
    • radiation()
    • radiation_crax()
    • register_scripts()
    • release()
    • rename_building()
    • run_all_plots()
    • schema()
    • sensitivity_analysis_sampler()
    • sewage_potential()
    • shallow_geothermal_potential()
    • shapefile_to_excel()
    • shp_to_csv_to_shp()
    • solar_collector()
    • streets_helper()
    • surroundings_helper()
    • system_costs()
    • terrain_helper()
    • test()
    • thermal_network()
    • thermal_network_detailed()
    • thermal_network_multiple_phase()
    • thermal_network_optimization()
    • trace_inputlocator()
    • trees_helper()
    • update_zenodo()
    • water_body_potential()
    • weather_helper()
    • workflow()
    • zone_helper()
  • cea.config module
    • BooleanParameter
    • BuildingsParameter
    • ChoiceParameter
    • ChoiceParameterBase
    • ColumnChoiceParameter
    • ColumnChoicesMixin
    • ColumnMultiChoiceParameter
    • ComponentMultiChoiceParameter
    • Configuration
    • CoordinateListParameter
    • CsvColumnNameParameter
    • DatabasePathParameter
    • DateParameter
    • DistrictSupplyTypeParameter
    • EnergyCarrierMultiChoiceParameter
    • ExportFolderNameParameter
    • FileParameter
    • GenerationParameter
    • InputFileParameter
    • IntegerParameter
    • InterventionTemplateMultiChoiceParameter
    • JsonParameter
    • ListParameter
    • MultiChoiceFeedstockParameter
    • MultiChoiceParameter
    • MultiSystemParameter
    • NetworkLayoutChoiceParameter
    • NetworkLayoutChoicesMixin
    • NetworkLayoutMultiChoiceParameter
    • NetworkLayoutNameParameter
    • NullablePathParameter
    • OptimizationIndividualListParameter
    • OptionalBuildingsParameter
    • OrderedMultiChoiceParameter
    • Parameter
    • PathParameter
    • PathwayConstructBuildingsParameter
    • PathwayDemolishBuildingsParameter
    • PhasingPlanChoiceParameter
    • PlantNodeParameter
    • PlotContextParameter
    • PluginListParameter
    • RealParameter
    • ScenarioNameChoicesMixin
    • ScenarioNameMultiChoiceParameter
    • ScenarioNameParameter
    • ScenarioParameter
    • Section
    • SimulatedPathwayMultiChoiceParameter
    • SingleBuildingParameter
    • SingleThermalStorageParameter
    • SolarPanelChoiceParameter
    • SolarPanelChoicesMixin
    • SolarPanelMultiChoiceParameter
    • SourceParameterMixin
    • StandardMultiChoiceParameter
    • StringParameter
    • SubfolderChoiceParameter
    • SubfolderMultiChoiceParameter
    • SubfoldersParameter
    • SystemParameter
    • UseTypeRatioParameter
    • UserNetworkInputFileParameter
    • WeatherPathParameter
    • WhatIfNameChoiceParameter
    • WhatIfNameChoicesMixin
    • WhatIfNameMultiChoiceParameter
    • WhatIfNameParameter
    • WorkflowParameter
    • _PathwayEventBuildingsParameter
    • _pathway_event_building_sets()
    • _validate_no_filesystem_invalid_chars()
    • _validate_user_network_input_exclusivity()
    • config_identifier()
    • get_scenarios_list()
    • get_systems_list()
    • parse_command_line_args()
    • parse_locator_kwargs()
    • parse_string_coordinate_list()
    • validate_coord_tuple()
  • cea.constants module
    • ASPECT_RATIO
    • AT_HEX_K
    • AT_MIN_K
    • BOLTZMANN
    • CONVERSION_AREA_TO_FLOOR_AREA_RATIO
    • CT_MAX_SIZE_W
    • DAYS_IN_YEAR
    • DENSITY_OF_WATER_AT_60_DEGREES_KGPERM3
    • EMISSIONS_EMBODIED_TECHNICAL_SYSTEMS
    • FT_TO_M
    • FT_WATER_TO_PA
    • H0_KWPERM2K
    • HEAT_CAPACITY_OF_WATER_JPERKGK
    • HEAT_CAPACITY_OF_WATER_VAPOR_JPERKGK
    • HEX_WIDTH_M
    • HOURS_IN_DAY
    • HOURS_IN_YEAR
    • HOURS_PRE_CONDITIONING
    • J_TO_WH
    • KELVIN_CONVERSION
    • LATENT_HEAT_OF_AIR_KJPERKG
    • MIN_FLOW_LPERS
    • MIN_TEMP_DIFF_FOR_HEAT_PUMP_OPERATION_K
    • MIN_TEMP_DIFF_FOR_HEX_LMTD_K
    • MIN_TEMP_DIFF_FOR_MASS_FLOW_K
    • MONTHS_IN_YEAR
    • M_WATER_TO_PA
    • PUR_lambda_WmK
    • P_SEWAGEWATER_KGPERM3
    • P_WATER_KGPERM3
    • SERVICE_LIFE_OF_BUILDINGS
    • SERVICE_LIFE_OF_TECHNICAL_SYSTEMS
    • SHAPEFILE_TOLERANCE
    • SNAP_TOLERANCE
    • SOIL_Cp_JkgK
    • SOIL_lambda_WmK
    • SOIL_rho_kgm3
    • STEEL_lambda_WmK
    • THERMAL_NETWORK_TEMPERATURE_CONVERGENCE_K
    • T_MIN
    • VEL_FLOW_MPERS
    • WH_TO_J
  • cea.glossary module
    • _generate_values_display()
    • glossary_row()
    • read_glossary_df()
  • cea.inputlocator module
    • InputLocator
    • ReferenceCaseOpenLocator
    • _read_structured_file()
    • _write_structured_file()
    • check_cpg()
  • cea.plugin module
    • CeaPlugin
    • add_plugins()
    • instantiate_plugin()
  • cea.schemas module
    • CsvSchemaIo
    • DbfSchemaIo
    • DefaultSchemaIo
    • SchemaIo
    • ShapefileSchemaIo
    • create_locator_method()
    • create_schema_io()
    • get_schema_scripts()
    • get_schema_variables()
    • schemas()
  • cea.scripts module
    • CeaScript
    • _load_scripts_yml()
    • by_name()
    • for_interface()
    • list_scripts()
    • tool_ref()
    • upstream_tool_labels()
  • cea.worker module
    • JobServerStream
    • close_streams()
    • configure_streams()
    • consume_nowait()
    • fetch_job()
    • get_worker_headers()
    • main()
    • parse_arguments()
    • post_error()
    • post_started()
    • post_success()
    • post_with_retry()
    • put_with_retry()
    • read_parameters()
    • read_script()
    • run_job()
    • signal_handler()
    • stream_poster()
    • worker()