Welcome to cesar-p documentation!

Contents:

• cesar-p - readme
  • Project Info
  • Project Status
    • Bug-Tracking & Open Issues
  • References
  • Installation & Usage
  • Contributing
  • Credits
• Installation
  • 1. EnergyPlus
  • 2. Python
  • 3. Create Python virtual environment
  • 4. cesar-p-core library
  • 5. optional: geopandas (for shp input file)
  • Update the cesar-p-core library
• Usage
  • Workflow
  • Set up simulation
    • 1. Configuration
    • 2. Main Script
    • 3. Run
    • 4. Outputs
  • Inputs to Cesar-P
  • Input Files Format
    • General
      • Absolute vs Relative Pathes
      • CSVY-Format
    • Site Vertices
    • Weather
    • Building information
  • Configuration structure
    • Numeric values / units
    • Pathes
  • Configuration overview
  • Result Summary
    • Base results from EnergyPlus simulation output
    • By CESAR-P post-processed Cost & Emission results
  • Run CESAR-P with Docker
  • GraphDB - Read data
    • Local File (TTL)
    • Remote connection to GraphDB server
  • GraphDB - Add or update data
    • Local data (TTL file)
    • GraphDB Server
  • API Overview
  • Visualize 3D geometry from IDF
• Features
  • Construction and Operation
    • Construction - Internal ceiling/floor
    • Custom assignment of operation parameters
    • Custom assignment of constructional Archetype
  • Construction Retrofit
    • Embodied Emissions and Costs
      • Wall, Roof, Ground
        • Embodied CO2 emissions and non-renewable PEN:
        • Costs
      • Windows
    • System retrofit and operational data
  • Life cycle emissions and costs
  • Building Geometry
    • Input and configuration overview
    • Implementation Notes
    • Windows
  • Neighbourhood
  • Passive cooling
    • Passive cooling by window shading
    • Passive cooling by night ventilation
  • SIA2024 Parameters and Schedules
    • Generation overview
    • Horizontal Variability
    • Implementation Notes
  • SIA2024 - Domestic Hotwater Demand
    • Usage profile
    • VARIANT A: DHW demand value based on SIA2024/2006 specific power “Spezifischer Wärmebedarf für Warmwasser” (as implemented in CESAR Matlab)
      • Resulting yearly demand - too low according to SIA2024/2016
    • VARIANT B: DHW demand value based on SIA2024/2016 hot water demand “Warmwasserbedarf pro Person” in liter/day/person
      • Variability for hotwater demand value
• Development
  • Development Installation
    • IDE Setup - Visual studio code
  • Development commands
    • Unittesting
    • Code formatting
    • Static code checker / Linting
    • Typing check
    • Doku generation
    • UML diagrams
  • Notes for developers
    • Configuration
    • How do I add support for a new EnergyPlus Version?
  • SW Architecture & Design of cesar-p
    • Intorduction and goals
      • Requirements Overview
        • Feature overview
      • Quality Goals
    • Architectural constraints
    • System scope and context
    • Building block view
      • Whitebox Overall System
        • Important Interfaces
    • Cross cutting concepts
      • Sub-Packages
      • Configuration
      • Dependency Injection
      • Programming paradigm
      • Type checking and contracts
      • Units
    • Design decisions
      • Datastorage
      • EPPY
      • Shapelib/Shaply
    • Detailed Design diagrams
      • Data model: BuildingModel
      • Creating data models: BldgModelFactory
      • Initialization of BldgModelFactory
      • Main workflow in SimulationManager
      • Retrofit
      • Operational costs and emissions
    • Glossary
  • Code Documentation
    • cesarp package
      • Subpackages
        • cesarp.SIA2024 package
          • SIA2024
          • Subpackages
            • cesarp.SIA2024.demand_generators package
              • Submodules
                • cesarp.SIA2024.demand_generators.ActivityHeatGainCalculator module
                • cesarp.SIA2024.demand_generators.AppliancesDemandGenerator module
                • cesarp.SIA2024.demand_generators.AreaPerPersonCalculator module
                • cesarp.SIA2024.demand_generators.BuildingTypeProtocol module
                  • BuildingTypeProtocol
                    • BuildingTypeProtocol.get_room_types()
                    • BuildingTypeProtocol.get_room_types_area_fraction()
                    • BuildingTypeProtocol.synthesize_profiles_yearly_by_room_area_for_bldg()
                    • BuildingTypeProtocol.synthesize_value_by_room_area()
                • cesarp.SIA2024.demand_generators.DHWDemandBasedOnLiterPerDayGenerator module
                • cesarp.SIA2024.demand_generators.DHWDemandGenerator module
                • cesarp.SIA2024.demand_generators.InfiltrationRateGenerator module
                • cesarp.SIA2024.demand_generators.LightingDemandGenerator module
                • cesarp.SIA2024.demand_generators.NighttimePatternGenerator module
                • cesarp.SIA2024.demand_generators.OccupancyProfileGenerator module
                • cesarp.SIA2024.demand_generators.ThermostatDemandGenerator module
                • cesarp.SIA2024.demand_generators.ValuePerKeyCache module
                  • ValuePerKeyCache
                    • ValuePerKeyCache.__init__()
                    • ValuePerKeyCache.lookup_value()
                • cesarp.SIA2024.demand_generators.VariationMonthly module
                • cesarp.SIA2024.demand_generators.VentilationDemandGenerator module
          • Submodules
            • cesarp.SIA2024.CSVYFileDumper module
            • cesarp.SIA2024.NullParametersFactory module
            • cesarp.SIA2024.SIA2024BuildingType module
            • cesarp.SIA2024.SIA2024DataAccessor module
            • cesarp.SIA2024.SIA2024Facade module
            • cesarp.SIA2024.SIA2024Parameters module
            • cesarp.SIA2024.SIA2024ParametersFactory module
            • cesarp.SIA2024.SIA2024ParamsManager module
            • cesarp.SIA2024.SIA2024_2016_RoomType module
              • SIA2024_2016_RoomType
                • SIA2024_2016_RoomType.Bathroom_with_shower
                • SIA2024_2016_RoomType.Car_park
                • SIA2024_2016_RoomType.Cinema_Theater_Concert_hall
                • SIA2024_2016_RoomType.Classroom
                • SIA2024_2016_RoomType.Cold_store
                • SIA2024_2016_RoomType.Corridor
                • SIA2024_2016_RoomType.Corridor_24h
                • SIA2024_2016_RoomType.Exhibition_hall
                • SIA2024_2016_RoomType.Food_store
                • SIA2024_2016_RoomType.Furniture_store
                • SIA2024_2016_RoomType.Gym
                • SIA2024_2016_RoomType.Heavy_industry
                • SIA2024_2016_RoomType.Hospital_unit_room
                • SIA2024_2016_RoomType.Hospital_ward
                • SIA2024_2016_RoomType.Hotel_room
                • SIA2024_2016_RoomType.Indoor_swimming_pool
                • SIA2024_2016_RoomType.Kitchen
                • SIA2024_2016_RoomType.Laboratory
                • SIA2024_2016_RoomType.Lecture_Hall
                • SIA2024_2016_RoomType.Library
                • SIA2024_2016_RoomType.Light_industry
                • SIA2024_2016_RoomType.Lobby
                • SIA2024_2016_RoomType.Locker_room_shower
                • SIA2024_2016_RoomType.MFH
                • SIA2024_2016_RoomType.Medical_treatment_room
                • SIA2024_2016_RoomType.Meeting_room
                • SIA2024_2016_RoomType.Multipurpose_hall
                • SIA2024_2016_RoomType.Office
                • SIA2024_2016_RoomType.Reception
                • SIA2024_2016_RoomType.Restaurant
                • SIA2024_2016_RoomType.Restaurant_kitchen
                • SIA2024_2016_RoomType.SFH
                • SIA2024_2016_RoomType.School_Staff_room
                • SIA2024_2016_RoomType.School_physics_chemistry_room
                • SIA2024_2016_RoomType.Self_service_restaurant_kitchen
                • SIA2024_2016_RoomType.Selfservice_restaurant
                • SIA2024_2016_RoomType.Server_room
                • SIA2024_2016_RoomType.Shopping_mall
                • SIA2024_2016_RoomType.Single_office
                • SIA2024_2016_RoomType.Sports_centre_School_gym
                • SIA2024_2016_RoomType.Staircase
                • SIA2024_2016_RoomType.Storage_space
                • SIA2024_2016_RoomType.WC
                • SIA2024_2016_RoomType.Warehouse
                • SIA2024_2016_RoomType.Washing_drying_room
        • cesarp.common package
          • Subpackages
            • cesarp.common.profiles package
              • Submodules
                • cesarp.common.profiles.profile_generation module
                • cesarp.common.profiles.profile_variability module
            • cesarp.common.typing package
              • Submodules
                • cesarp.common.typing.CustomProtocols module
          • Submodules
            • cesarp.common.AgeClass module
            • cesarp.common.CesarpException module
            • cesarp.common.DatasetMetadata module
            • cesarp.common.ScheduleFile module
            • cesarp.common.ScheduleFixedValue module
            • cesarp.common.ScheduleTypeLimits module
            • cesarp.common.ScheduleValues module
            • cesarp.common.config_loader module
            • cesarp.common.csv_reader module
            • cesarp.common.csv_writer module
            • cesarp.common.filehandling module
            • cesarp.common.version_info module
        • cesarp.construction package
          • construction
          • Submodules
            • cesarp.construction.ConstructionBasics module
            • cesarp.construction.ConstructionBuilder module
            • cesarp.construction.ConstructionFacade module
            • cesarp.construction.ListWithDefault module
              • ListWithDefault
                • ListWithDefault.__init__()
                • ListWithDefault.get_value()
            • cesarp.construction.MinMaxValue module
            • cesarp.construction.NeighbouringBldgConstructionFactory module
            • cesarp.construction.construction_protocols module
        • cesarp.emissons_cost package
          • emissions_cost
          • Submodules
            • cesarp.emissons_cost.EmissionAndCostCalculationError module
              • EmissonAndCostCalculationError
                • EmissonAndCostCalculationError.__init__()
            • cesarp.emissons_cost.OperationalEmissionsAndCosts module
        • cesarp.energy_strategy package
          • Submodules
            • cesarp.energy_strategy.EnergyMix module
            • cesarp.energy_strategy.EnergyStrategy module
            • cesarp.energy_strategy.FuelCosts module
            • cesarp.energy_strategy.RetrofitRates module
            • cesarp.energy_strategy.SystemEfficiencies module
            • cesarp.energy_strategy.input_parser_helper module
        • cesarp.eplus_adapter package
          • eplus_adapter
          • Submodules
            • cesarp.eplus_adapter.CesarIDFWriter module
            • cesarp.eplus_adapter.ConstructionIDFWritingHandler module
            • cesarp.eplus_adapter.EPlusEioResultAnalyzer module
            • cesarp.eplus_adapter.RelativeAuxiliaryFilesHandler module
              • RelativeAuxiliaryFilesHandler
                • RelativeAuxiliaryFilesHandler.__init__()
                • RelativeAuxiliaryFilesHandler.add_file()
                • RelativeAuxiliaryFilesHandler.set_destination()
            • cesarp.eplus_adapter.eplus_error_file_handling module
              • EplusErrorLevel
                • EplusErrorLevel.FATAL
                • EplusErrorLevel.IP_NOTE
                • EplusErrorLevel.NO_ERRORS
                • EplusErrorLevel.SEVERE
                • EplusErrorLevel.UNKNOWN
                • EplusErrorLevel.WARNING
              • check_eplus_error_level()
            • cesarp.eplus_adapter.eplus_eso_results_handling module
            • cesarp.eplus_adapter.eplus_res_surface_solar_potential module
            • cesarp.eplus_adapter.eplus_sim_runner module
            • cesarp.eplus_adapter.idf_strings module
              • BldgSurfaceType
                • BldgSurfaceType.ceiling
                • BldgSurfaceType.floor
                • BldgSurfaceType.roof
                • BldgSurfaceType.wall
              • ColumnSeparator
                • ColumnSeparator.comma_and_html
              • CoordinateSystem
                • CoordinateSystem.relative
              • Coords
                • Coords.num_format
                • Coords.xcoordinate_pattern
                • Coords.ycoordinate_pattern
                • Coords.zcoordinate_pattern
              • CustomObjNames
                • CustomObjNames.bldg_zone_name
                • CustomObjNames.building
                • CustomObjNames.ceiling_name
                • CustomObjNames.constant_schedule
                • CustomObjNames.electric_equipment
                • CustomObjNames.floor_name
                • CustomObjNames.frame_and_divider
                • CustomObjNames.groundfloor_name
                • CustomObjNames.hot_water_equipment
                • CustomObjNames.lights
                • CustomObjNames.outdoor_air_spec
                • CustomObjNames.people
                • CustomObjNames.roof_name
                • CustomObjNames.run_periods
                • CustomObjNames.shading_bldg_roof_name
                • CustomObjNames.shading_bldg_wall_name
                • CustomObjNames.thermostat_template
                • CustomObjNames.wall_name
                • CustomObjNames.window_name
                • CustomObjNames.zone_infiltration
              • DesignLevelCalc
                • DesignLevelCalc.watts_per_area
              • FenestrationSurfaceType
                • FenestrationSurfaceType.window
              • FlowRateCalculationMethod
                • FlowRateCalculationMethod.air_changes_per_hour
                • FlowRateCalculationMethod.flow_per_zone_area
              • GroundTempFieldNamePatterns
                • GroundTempFieldNamePatterns.building_surface
                • GroundTempFieldNamePatterns.deep
                • GroundTempFieldNamePatterns.fcfactormethod
                • GroundTempFieldNamePatterns.shallow
              • HVACOutdoorAirMethod
                • HVACOutdoorAirMethod.detailed_specification
              • IDFObjects
                • IDFObjects.bldg_surface_detailed
                • IDFObjects.building
                • IDFObjects.construction
                • IDFObjects.convergence_limits
                • IDFObjects.design_specifictaion_outdoor_air
                • IDFObjects.desing_specifiction_outdoorair
                • IDFObjects.electric_equipment
                • IDFObjects.fenestration_surface_detailed
                • IDFObjects.global_geometry_rules
                • IDFObjects.hot_water_equipment
                • IDFObjects.hvac_template_thermostat
                • IDFObjects.hvac_template_zone_idealloadsairsystem
                • IDFObjects.ligths
                • IDFObjects.material
                • IDFObjects.material_air_gap
                • IDFObjects.material_no_mass
                • IDFObjects.output_control_table_style
                • IDFObjects.output_meter
                • IDFObjects.output_table_summary_reports
                • IDFObjects.output_variable
                • IDFObjects.output_variable_dictionary
                • IDFObjects.people
                • IDFObjects.run_period
                • IDFObjects.schedule_compact
                • IDFObjects.schedule_const
                • IDFObjects.schedule_file
                • IDFObjects.schedule_type_limits
                • IDFObjects.shading_bldg_detailed
                • IDFObjects.shading_prop_reflectance
                • IDFObjects.shadow_calculation
                • IDFObjects.simulation_control
                • IDFObjects.site_ground_temperature_building_surface
                • IDFObjects.site_ground_temperature_deep
                • IDFObjects.site_ground_temperature_fc_factor_method
                • IDFObjects.site_ground_temperature_shallow
                • IDFObjects.timestep
                • IDFObjects.win_material_gas
                • IDFObjects.win_material_glazing
                • IDFObjects.win_shade_material
                • IDFObjects.win_shading_ctrl_ep8
                • IDFObjects.win_shading_ctrl_ep9
                • IDFObjects.window_property_frame_and_divider
                • IDFObjects.zone
                • IDFObjects.zone_air_heat_balance_algorithm
                • IDFObjects.zone_infiltration_design_flow_rate
                • IDFObjects.zoneinfiltration_designflowrate
              • KeyField
                • KeyField.idf
              • NumOfPeopleCalc
                • NumOfPeopleCalc.area_per_person
              • NumericType
                • NumericType.continuous
                • NumericType.discrete
                • NumericType.get_num_type_for()
              • OutdoorAirCalcMethod
                • OutdoorAirCalcMethod.flow_per_area
              • OutsideBoundaryCond
                • OutsideBoundaryCond.adiabatic
                • OutsideBoundaryCond.ground
                • OutsideBoundaryCond.outdoors
                • OutsideBoundaryCond.surface
              • ResultsFrequency
                • ResultsFrequency.ANNUAL
                • ResultsFrequency.DAILY
                • ResultsFrequency.DETAILED
                • ResultsFrequency.HOURLY
                • ResultsFrequency.MONTHLY
                • ResultsFrequency.TIMESTEP
              • Roughness
                • Roughness.MediumRough
                • Roughness.MediumSmooth
                • Roughness.Rough
                • Roughness.Smooth
                • Roughness.VeryRough
                • Roughness.VerySmooth
              • Separator
                • Separator.comma
                • Separator.get_for_char()
                • Separator.semicolon
                • Separator.tab
              • SummaryReports
                • SummaryReports.all_summary
              • UnitConversion
                • UnitConversion.j_to_kwh
              • VertexEntryDirection
                • VertexEntryDirection.counter_clockwise
              • VertexPosition
                • VertexPosition.lower_left_corner
              • ViewFactorToGround
                • ViewFactorToGround.adjacent
                • ViewFactorToGround.autocalculate
                • ViewFactorToGround.horizontal_down
                • ViewFactorToGround.horizontal_up
                • ViewFactorToGround.indoors
              • WeahterCond
                • WeahterCond.not_sun_exposed
                • WeahterCond.not_wind_exposed
                • WeahterCond.sun_exposed
                • WeahterCond.wind_exposed
              • Weekdays
                • Weekdays.sunday
              • WindowMatGlazing
                • WindowMatGlazing.optical_data_type
              • ZoneAirHeatBalanceAlgorithm
                • ZoneAirHeatBalanceAlgorithm.analytical_solution
            • cesarp.eplus_adapter.idf_writer_construction module
            • cesarp.eplus_adapter.idf_writer_geometry module
            • cesarp.eplus_adapter.idf_writer_night_vent module
            • cesarp.eplus_adapter.idf_writer_operation module
            • cesarp.eplus_adapter.idf_writer_window_shading module
            • cesarp.eplus_adapter.idf_writing_helpers module
        • cesarp.geometry package
          • geometry
          • Submodules
            • cesarp.geometry.CesarGeometryException module
              • CesarGeometryException
                • CesarGeometryException.__init__()
            • cesarp.geometry.GeometryBuilder module
            • cesarp.geometry.GeometryBuilderFactory module
            • cesarp.geometry.area_calculator module
            • cesarp.geometry.building module
            • cesarp.geometry.csv_input_parser module
            • cesarp.geometry.custom_contracts module
            • cesarp.geometry.neighbourhood module
            • cesarp.geometry.shp_input_parser module
            • cesarp.geometry.vertices_basics module
        • cesarp.graphdb_access package
          • graphdb_access
          • Submodules
            • cesarp.graphdb_access.ArchetypicalConstructionGraphDBBased module
            • cesarp.graphdb_access.BldgElementConstructionReader module
            • cesarp.graphdb_access.BuildingElementConstructionsArchetype module
            • cesarp.graphdb_access.ConstructionRetrofitter module
            • cesarp.graphdb_access.GraphDBArchetypicalConstructionFactory module
            • cesarp.graphdb_access.GraphDBFacade module
            • cesarp.graphdb_access.GraphDBReader module
            • cesarp.graphdb_access.GraphDataException module
              • GraphDataException
            • cesarp.graphdb_access.LocalFileReader module
            • cesarp.graphdb_access.sparql_queries module
        • cesarp.manager package
          • Submodules
            • cesarp.manager.BldgModelFactory module
            • cesarp.manager.BuildingContainer module
            • cesarp.manager.FileStorageHandler module
            • cesarp.manager.GlazingRatioBldgSpecific module
            • cesarp.manager.ProjectManager module
            • cesarp.manager.ProjectSaver module
            • cesarp.manager.SimulationManager module
            • cesarp.manager.debug_methods module
            • cesarp.manager.json_pickling module
            • cesarp.manager.manager_protocols module
            • cesarp.manager.processing_steps module
        • cesarp.model package
          • model
          • Submodules
            • cesarp.model.BldgShape module
            • cesarp.model.BldgType module
              • BldgType
                • BldgType.HOSPITAL
                • BldgType.MFH
                • BldgType.OFFICE
                • BldgType.RESTAURANT
                • BldgType.SCHOOL
                • BldgType.SFH
                • BldgType.SHOP
            • cesarp.model.BuildingConstruction module
            • cesarp.model.BuildingElement module
              • BuildingElement
                • BuildingElement.GROUNDFLOOR
                • BuildingElement.INTERNAL_CEILING
                • BuildingElement.INTERNAL_FLOOR
                • BuildingElement.ROOF
                • BuildingElement.WALL
                • BuildingElement.WINDOW
            • cesarp.model.BuildingModel module
            • cesarp.model.BuildingOperation module
            • cesarp.model.BuildingOperationMapping module
            • cesarp.model.Construction module
            • cesarp.model.EnergySource module
              • EnergySource
                • EnergySource.COAL
                • EnergySource.DHW_OTHER
                • EnergySource.DISTRICT_HEATING
                • EnergySource.ELECTRICITY
                • EnergySource.GAS
                • EnergySource.HEATING_OIL
                • EnergySource.HEATING_OTHER
                • EnergySource.HEAT_PUMP
                • EnergySource.NO
                • EnergySource.SOLAR_THERMAL
                • EnergySource.WOOD
            • cesarp.model.Gas module
            • cesarp.model.Layer module
            • cesarp.model.OpaqueMaterial module
            • cesarp.model.ShadingObjectConstruction module
            • cesarp.model.Site module
            • cesarp.model.SiteGroundTemperatures module
            • cesarp.model.TransparentMaterial module
            • cesarp.model.WindowConstruction module
            • cesarp.model.WindowLayer module
        • cesarp.operation package
          • operation
          • Subpackages
            • cesarp.operation.fixed package
              • Submodules
                • cesarp.operation.fixed.FixedBuildingOperationFactory module
          • Submodules
            • cesarp.operation.PassiveCoolingOperationFactory module
            • cesarp.operation.protocols module
        • cesarp.results package
          • results
          • Submodules
            • cesarp.results.EnergyDemandSimulationResults module
            • cesarp.results.ResultProcessor module
        • cesarp.retrofit package
          • Subpackages
            • cesarp.retrofit.all_bldgs package
              • Submodules
                • cesarp.retrofit.all_bldgs.SimpleRetrofitManager module
            • cesarp.retrofit.embodied package
              • Submodules
                • cesarp.retrofit.embodied.ConstructionRetrofitCosts module
                • cesarp.retrofit.embodied.InsulationCosts module
                • cesarp.retrofit.embodied.RetrofitEmbodiedEmissions module
                • cesarp.retrofit.embodied.retrofit_input_parser module
            • cesarp.retrofit.energy_perspective_2050 package
              • Submodules
                • cesarp.retrofit.energy_perspective_2050.EnergyPerspective2050BldgElementsRetrofitter module
                • cesarp.retrofit.energy_perspective_2050.EnergyPerspective2050RetrofitManager module
                • cesarp.retrofit.energy_perspective_2050.EnergyTargetLookup module
          • Submodules
            • cesarp.retrofit.BuildingElementsRetrofitter module
            • cesarp.retrofit.RetrofitLog module
            • cesarp.retrofit.retrofit_protocols module
        • cesarp.site package
          • site
          • Submodules
            • cesarp.site.SingleSiteFactory module
            • cesarp.site.SiteGroundTemperatureFactory module
            • cesarp.site.SitePerBuildingSpecificWeatherFile module
            • cesarp.site.SitePerSwissCommunityFactory module
        • cesarp.weather package
          • Subpackages
            • cesarp.weather.swiss_communities package
              • Subpackages
                • cesarp.weather.swiss_communities.ressources package
              • Submodules
                • cesarp.weather.swiss_communities.SwissCommunityWeatherChooser module
• FAQ
  • CESAR-P crashes after update
  • CESAR-P crashes/hangs without an error
  • Can I use a *.shp file as input for the Site Vertices?
  • How can I run CESAR-P using x Cores / running in parallel?
  • How do I best fix/debug tests?
  • What is the version scheme of CESAR-P?
• History & Release Notes
  • Version Numbers
  • 2.4.0
  • 2.3.3
  • 2.3.2
  • 2.3.1
  • 2.3.0
  • 2.2.0
  • 2.1.0
  • 2.0.1
  • 2.0.0
  • 1.3.0
• References and Data Sources

Indices and tables

• Module Index

• Search Page