Welcome to cesar-p documentation!

Contents:

• cesar-p - readme
  • Project Info
  • Project Status
    • Bug-Tracking & Open Issues
  • References
  • Installation
    • EnergyPlus
    • Python
    • A - Install (& Update) CESAR-P as python package
    • B - Editable mode / Development
  • Usage
    • 1. Configuration
    • 2. Main Script
    • 3. Run
    • 4. Outputs
  • Run CESAR-P with Docker
  • Development commands
  • Credits
• Installation
• Usage & Configuration
  • YML configuration files
• Input Files Format
  • General
    • Absolute vs Relative Pathes
    • CSVY-Format
  • Site Vertices
  • Weather
  • Building information
• Result Summary
  • Base results from EnergyPlus simulation output
  • By CESAR-P post-processed Cost & Emission results
• 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?
• Features
  • Construction and Operation
    • Data source
    • 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
  • GraphDB Database
    • Local File
    • Remote connection to GraphDB server
  • 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
• API Documentation
  • cesarp package
    • Subpackages
      • cesarp.SIA2024 package
        • 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
              • 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
              • cesarp.SIA2024.demand_generators.VariationMonthly module
              • cesarp.SIA2024.demand_generators.VentilationDemandGenerator module
            • Module contents
        • 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
        • Module contents
      • cesarp.common package
        • Subpackages
          • cesarp.common.profiles package
            • Submodules
              • cesarp.common.profiles.profile_generation module
              • cesarp.common.profiles.profile_variability module
            • Module contents
          • cesarp.common.typing package
            • Submodules
              • cesarp.common.typing.CustomProtocols module
            • Module contents
        • 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
        • Module contents
      • cesarp.construction package
        • Submodules
          • cesarp.construction.ConstructionBasics module
          • cesarp.construction.ConstructionBuilder module
          • cesarp.construction.ConstructionFacade module
          • cesarp.construction.ListWithDefault module
          • cesarp.construction.MinMaxValue module
          • cesarp.construction.NeighbouringBldgConstructionFactory module
          • cesarp.construction.construction_protocols module
        • Module contents
      • cesarp.emissons_cost package
        • Submodules
          • cesarp.emissons_cost.EmissionAndCostCalculationError module
          • cesarp.emissons_cost.OperationalEmissionsAndCosts module
        • Module contents
      • 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
        • Module contents
      • cesarp.eplus_adapter package
        • Submodules
          • cesarp.eplus_adapter.CesarIDFWriter module
          • cesarp.eplus_adapter.ConstructionIDFWritingHandler module
          • cesarp.eplus_adapter.EPlusEioResultReader module
          • cesarp.eplus_adapter.RelativeAuxiliaryFilesHandler module
          • cesarp.eplus_adapter.eplus_error_file_handling module
          • cesarp.eplus_adapter.eplus_eso_results_handling module
          • cesarp.eplus_adapter.eplus_sim_runner module
          • cesarp.eplus_adapter.idf_strings module
          • 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
        • Module contents
      • cesarp.geometry package
        • Submodules
          • cesarp.geometry.CesarGeometryException module
          • 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
        • Module contents
      • cesarp.graphdb_access package
        • 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
          • cesarp.graphdb_access.LocalFileReader module
          • cesarp.graphdb_access.sparql_queries module
        • Module contents
      • cesarp.idf_constructions_db_access package
        • Submodules
          • cesarp.idf_constructions_db_access.ArchetypicalConstructionIDFBased module
          • cesarp.idf_constructions_db_access.ConstructionAsIDF module
          • cesarp.idf_constructions_db_access.IDFConstructionArchetypeFactory module
          • cesarp.idf_constructions_db_access.input_parser module
        • Module contents
      • 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
        • Module contents
      • cesarp.model package
        • Submodules
          • cesarp.model.BldgShape module
          • cesarp.model.BldgType module
          • cesarp.model.BuildingConstruction module
          • cesarp.model.BuildingElement module
          • cesarp.model.BuildingModel module
          • cesarp.model.BuildingOperation module
          • cesarp.model.BuildingOperationMapping module
          • cesarp.model.Construction module
          • cesarp.model.EnergySource module
          • 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
        • Module contents
      • cesarp.operation package
        • Subpackages
          • cesarp.operation.fixed package
            • Submodules
              • cesarp.operation.fixed.FixedBuildingOperationFactory module
            • Module contents
        • Submodules
          • cesarp.operation.PassiveCoolingOperationFactory module
          • cesarp.operation.protocols module
        • Module contents
      • cesarp.results package
        • Submodules
          • cesarp.results.EnergyDemandSimulationResults module
          • cesarp.results.ResultProcessor module
        • Module contents
      • cesarp.retrofit package
        • Subpackages
          • cesarp.retrofit.all_bldgs package
            • Submodules
              • cesarp.retrofit.all_bldgs.SimpleRetrofitManager module
            • Module contents
          • 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
            • Module contents
          • 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
            • Module contents
        • Submodules
          • cesarp.retrofit.BuildingElementsRetrofitter module
          • cesarp.retrofit.RetrofitLog module
          • cesarp.retrofit.retrofit_protocols module
        • Module contents
      • cesarp.site package
        • Submodules
          • cesarp.site.SingleSiteFactory module
          • cesarp.site.SiteGroundTemperatureFactory module
          • cesarp.site.SitePerSwissCommunityFactory module
        • Module contents
      • cesarp.weather package
        • Subpackages
          • cesarp.weather.swiss_communities package
            • Subpackages
              • cesarp.weather.swiss_communities.ressources package
                • Module contents
            • Submodules
              • cesarp.weather.swiss_communities.SwissCommunityWeatherChooser module
            • Module contents
        • Module contents
    • Module contents
• 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
      • Motivation
      • Important Interfaces
  • Cross cutting concepts
    • Sub-Packages
    • Configuration
    • Dependency Injection
    • Programming paradigm
    • Type checking and contracts
    • Units
  • Design decisions
    • Datastorage
    • EPPY
    • Shapelib/Shaply
  • Glossary
  • Detailed Design diagrams
    • Data model: BuildingModel
    • Creating data models: BldgModelFactory
    • Initialization of BldgModelFactory
    • Main workflow in SimulationManager
    • Retrofit
    • Operational costs and emissions
• Development commands
  • Unittesting
  • Static code checker / Linting
  • Typing check
  • Code formatting
  • Doku generation
  • UML diagrams
• Notes for developers
  • Configuration
  • Implementation notes
• History & Release Notes
  • Version Numbers
  • 1.3.0
• References and Data Sources

Indices and tables

• Index

• Module Index

• Search Page