API Overview

The main API classes for cesar-p-core lib are listed in the table below. The example scripts mentioned are located in the separate cesar-p-usage-examples repository (see cesar-p - readme for the link).

class/module

description

example

cesarp.manager.SimulationManager

Used for the simulation of a site

simple_example/ simple_run.py advanced_example/ basic_cesar_usage.py

cesarp.manager.ProjectManager

used to manage different runs/variants for the same site

advanced_example/ multi_scenario/ multi_scenarios.py

cesarp.manager.BuildingContainer

this is the main data management class - one container is created per building, each with the bldg model and results

advanced_example/ basic_cesar_usage.py::load_from_disk

cesarp.manager.BuildingModel

the CESAR-P representation for a building containing all parameters needed to create the idf file

cesarp.retrofit.all_bldgs.SimpleRetrofitManager

if you want to run a retrofit scenario with a simple retrofit strategy, namely retrofitting all or part of the building elements for all buildings

advanced_example/ retrofit_simple_example.py

cesarp.retrofit.energy_perspective_2050.EnergyPerspective2050RetrofitManager.py

retrofit of the building site to match the energy 2050 strategy

advanced_example/ retrofit_energy_strategy2050_example.py

cesarp.retrofit.all_bldgs.RetrofitLog

used to keep track of retrofit measures along with thier cost and emissions, returned by the retrofit manager’s above