Search.setIndex({docnames:["index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,"sphinx.ext.todo":2,"sphinx.ext.viewcode":1,sphinx:56},filenames:["index.rst"],objects:{"city_model_structure.bixi_feature":{BixiFeature:[0,1,1,""]},"city_model_structure.bixi_feature.BixiFeature":{feature_type:[0,2,1,""],length:[0,2,1,""]},"city_model_structure.building":{Building:[0,1,1,""]},"city_model_structure.building.Building":{"function":[0,2,1,""],attic_heated:[0,2,1,""],average_storey_height:[0,2,1,""],basement_heated:[0,2,1,""],foot_print:[0,2,1,""],heated_volume:[0,2,1,""],max_height:[0,2,1,""],name:[0,2,1,""],stl_export:[0,2,1,""],storeys_above_ground:[0,2,1,""],terrains:[0,2,1,""],thermal_zones:[0,2,1,""],type:[0,2,1,""],usage_zones:[0,2,1,""],year_of_construction:[0,2,1,""]},"city_model_structure.city":{City:[0,1,1,""]},"city_model_structure.city.City":{add_city_object:[0,2,1,""],bixi_features:[0,2,1,""],buildings:[0,2,1,""],city_object:[0,2,1,""],city_objects:[0,2,1,""],composting_plants:[0,2,1,""],country_code:[0,2,1,""],lower_corner:[0,2,1,""],name:[0,2,1,""],srs_name:[0,2,1,""],trees:[0,2,1,""],upper_corner:[0,2,1,""]},"city_model_structure.city_object":{CityObject:[0,1,1,""]},"city_model_structure.city_object.CityObject":{location:[0,2,1,""],lod:[0,2,1,""],surface:[0,2,1,""],surfaces:[0,2,1,""],volume:[0,2,1,""]},"city_model_structure.composting_plant":{CompostingPlant:[0,1,1,""]},"city_model_structure.composting_plant.CompostingPlant":{capacity:[0,2,1,""],waste_type:[0,2,1,""]},"city_model_structure.internal_gains":{InternalGains:[0,1,1,""]},"city_model_structure.internal_gains.InternalGains":{average_internal_gain:[0,2,1,""],convective_fraction:[0,2,1,""],latent_fraction:[0,2,1,""],radiative_fraction:[0,2,1,""]},"city_model_structure.layer":{Layer:[0,1,1,""]},"city_model_structure.layer.Layer":{material:[0,2,1,""],thickness:[0,2,1,""]},"city_model_structure.material":{Material:[0,1,1,""]},"city_model_structure.material.Material":{conductivity:[0,2,1,""],density:[0,2,1,""],no_mass:[0,2,1,""],solar_absorptance:[0,2,1,""],specific_heat:[0,2,1,""],thermal_absorptance:[0,2,1,""],thermal_resistance:[0,2,1,""],visible_absorptance:[0,2,1,""]},"city_model_structure.polyhedron":{Polyhedron:[0,1,1,""]},"city_model_structure.polyhedron.Polyhedron":{"export":[0,2,1,""],centroid:[0,2,1,""],faces:[0,2,1,""],max_z:[0,2,1,""],vertices:[0,2,1,""],volume:[0,2,1,""]},"city_model_structure.surface":{Surface:[0,1,1,""]},"city_model_structure.surface.Surface":{add_shared:[0,2,1,""],area:[0,2,1,""],area_above_ground:[0,2,1,""],area_below_ground:[0,2,1,""],azimuth:[0,2,1,""],global_irradiance_hour:[0,2,1,""],global_irradiance_month:[0,2,1,""],ground_points:[0,2,1,""],ground_polygon:[0,2,1,""],inclination:[0,2,1,""],intersect:[0,2,1,""],min_x:[0,2,1,""],min_y:[0,2,1,""],min_z:[0,2,1,""],name:[0,2,1,""],normal:[0,2,1,""],parent:[0,2,1,""],points:[0,2,1,""],points_list:[0,2,1,""],polygon:[0,2,1,""],projection:[0,2,1,""],shapely:[0,2,1,""],shared:[0,2,1,""],swr:[0,2,1,""],type:[0,2,1,""]},"city_model_structure.thermal_boundary":{ThermalBoundary:[0,1,1,""]},"city_model_structure.thermal_boundary.ThermalBoundary":{area:[0,2,1,""],area_above_ground:[0,2,1,""],area_below_ground:[0,2,1,""],azimuth:[0,2,1,""],delimits:[0,2,1,""],inclination:[0,2,1,""],layers:[0,2,1,""],outside_solar_absorptance:[0,2,1,""],outside_thermal_absorptance:[0,2,1,""],outside_visible_absorptance:[0,2,1,""],shortwave_reflectance:[0,2,1,""],thermal_openings:[0,2,1,""],type:[0,2,1,""],u_value:[0,2,1,""],window_area:[0,2,1,""],window_ratio:[0,2,1,""]},"city_model_structure.thermal_opening":{ThermalOpening:[0,1,1,""]},"city_model_structure.thermal_opening.ThermalOpening":{back_side_solar_transmittance_at_normal_incidence:[0,2,1,""],conductivity:[0,2,1,""],frame_ratio:[0,2,1,""],front_side_solar_transmittance_at_normal_incidence:[0,2,1,""],g_value:[0,2,1,""],openable_ratio:[0,2,1,""],overall_u_value:[0,2,1,""],thickness:[0,2,1,""]},"city_model_structure.thermal_zone":{ThermalZone:[0,1,1,""]},"city_model_structure.thermal_zone.ThermalZone":{additional_thermal_bridge_u_value:[0,2,1,""],bounded:[0,2,1,""],cooled:[0,2,1,""],effective_thermal_capacity:[0,2,1,""],floor_area:[0,2,1,""],heated:[0,2,1,""],indirectly_heated_area_ratio:[0,2,1,""],infiltration_rate_system_off:[0,2,1,""],infiltration_rate_system_on:[0,2,1,""],surfaces:[0,2,1,""],usage_zones:[0,2,1,""]},"city_model_structure.tree":{Tree:[0,1,1,""]},"city_model_structure.tree.Tree":{canopy:[0,2,1,""],height:[0,2,1,""]},"city_model_structure.usage_zone":{UsageZone:[0,1,1,""]},"city_model_structure.usage_zone.UsageZone":{cooling_setpoint:[0,2,1,""],days_year:[0,2,1,""],heating_setback:[0,2,1,""],heating_setpoint:[0,2,1,""],hours_day:[0,2,1,""],internal_gains:[0,2,1,""],mechanical_air_change:[0,2,1,""],usage:[0,2,1,""]},"geometry.geometry_factory":{GeometryFactory:[0,1,1,""]},"geometry.geometry_factory.GeometryFactory":{city:[0,2,1,""]},"physics.physics_factory":{PhysicsFactory:[0,1,1,""]},"physics.physics_factory.PhysicsFactory":{factory:[0,2,1,""]},"usage.usage_factory":{UsageFactory:[0,1,1,""]},"usage.usage_factory.UsageFactory":{factory:[0,2,1,""]},city_model_structure:{bixi_feature:[0,0,0,"-"],building:[0,0,0,"-"],city:[0,0,0,"-"],city_object:[0,0,0,"-"],composting_plant:[0,0,0,"-"],internal_gains:[0,0,0,"-"],layer:[0,0,0,"-"],material:[0,0,0,"-"],polyhedron:[0,0,0,"-"],surface:[0,0,0,"-"],thermal_boundary:[0,0,0,"-"],thermal_opening:[0,0,0,"-"],thermal_zone:[0,0,0,"-"],tree:[0,0,0,"-"],usage_zone:[0,0,0,"-"]},geometry:{geometry_factory:[0,0,0,"-"]},physics:{physics_factory:[0,0,0,"-"]},usage:{usage_factory:[0,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method"},terms:{"boolean":0,"class":0,"export":0,"float":0,"function":0,"int":0,"return":0,"short":0,"true":0,NOT:0,abov:0,absorpt:0,add:0,add_city_object:0,add_shar:0,additional_thermal_bridge_u_valu:0,air:0,ani:0,area:0,area_above_ground:0,area_below_ground:0,assign:0,attic:0,attic_h:0,author:0,averag:0,average_internal_gain:0,average_storey_height:0,azimuth:0,back:0,back_side_solar_transmittance_at_normal_incid:0,base_path:0,basement:0,basement_h:0,belong:0,below:0,between:0,bixi_featur:0,bixifeatur:0,bound:0,bridg:0,can:0,canopi:0,capac:0,celsiu:0,centroid:0,chang:0,check:0,city_model_structur:0,city_object:0,city_object_nam:0,cityobject:0,code:0,code_of_conduct:0,coeffici:0,composting_pl:0,compostingpl:0,concordia:0,conduct:0,configur:0,construct:0,contribut:0,convect:0,convective_fract:0,cool:0,cooling_setpoint:0,coordin:0,copyright:0,corner:0,countri:0,country_cod:0,cubic:0,dai:0,data:0,days_year:0,delimit:0,densiti:0,detail:0,effect:0,effective_thermal_capac:0,enrich:0,except:0,extern:0,face:0,fals:0,feature_typ:0,file_typ:0,flag:0,floor:0,floor_area:0,foot:0,foot_print:0,format:0,fraction:0,frame:0,frame_ratio:0,from:0,front:0,front_side_solar_transmittance_at_normal_incid:0,full_path:0,g_valu:0,geometr:0,geometry_factori:0,geometryfactori:0,get:0,given:0,global:0,global_irradiance_hour:0,global_irradiance_month:0,grad:0,ground:0,ground_point:0,ground_polygon:0,guill:0,guillermo:0,gutierrez:0,gutierrezmorot:0,handler:0,heat:0,heated_volum:0,heating_setback:0,heating_setpoint:0,height:0,hour:0,hours_dai:0,identifi:0,implement:0,incid:0,inclin:0,index:0,indirectli:0,indirectly_heated_area_ratio:0,infiltr:0,infiltration_rate_system_off:0,infiltration_rate_system_on:0,inform:0,ini:0,internal_gain:0,internalgain:0,intersect:0,intersection_area:0,irradi:0,is_project:0,kgk:0,latent:0,latent_fract:0,later:0,length:0,level:0,lgpl:0,licens:0,list:0,load:0,locat:0,lod:0,lower:0,lower_corn:0,m2k:0,mass:0,matrix:0,max_height:0,max_z:0,maxim:0,mechan:0,mechanical_air_chang:0,meter:0,min_i:0,min_x:0,min_z:0,minim:0,modul:0,month:0,name:0,ndarrai:0,new_city_object:0,no_mass:0,none:0,normal:0,notimplementederror:0,number:0,off:0,openable_ratio:0,option:0,outsid:0,outside_solar_absorpt:0,outside_thermal_absorpt:0,outside_visible_absorpt:0,overal:0,overall_u_valu:0,page:0,param:0,parent:0,path:0,per:0,percent:0,physics_factori:0,physicsfactor:0,physicsfactori:0,point:0,points_list:0,polygon:0,print:0,project:0,properti:0,pyguid:0,pyny3d:0,radi:0,radian:0,radiative_fract:0,rate:0,ratio:0,readm:0,reflect:0,region:0,remove_last:0,resist:0,retriev:0,roof:0,search:0,set:0,setback:0,setpoint:0,shape:0,share:0,shortwav:0,shortwave_reflect:0,side:0,solar:0,solar_absorpt:0,some:0,sourc:0,spdx:0,specif:0,specific_heat:0,squar:0,srs:0,srs_name:0,stl:0,stl_export:0,storei:0,storeys_above_ground:0,str:0,surface_id:0,surface_typ:0,swr:0,system:0,terrain:0,thermal_absorpt:0,thermal_boundari:0,thermal_open:0,thermal_resist:0,thermal_zon:0,thermalboundari:0,thermalopen:0,thermalzon:0,thi:0,thick:0,transmitt:0,treat:0,type:0,u_valu:0,upper:0,upper_corn:0,usage_factori:0,usage_zon:0,usagefactori:0,usagezon:0,valu:0,vector:0,vertic:0,visibl:0,visible_absorpt:0,volum:0,wall:0,waste_typ:0,wave:0,window:0,window_area:0,window_ratio:0,year:0,year_of_construct:0},titles:["Welcome to CERC libs\u2019s documentation!"],titleterms:{addit:0,bixi:0,boundari:0,build:0,cerc:0,citi:0,compost:0,document:0,factori:0,featur:0,file:0,gain:0,geometri:0,indic:0,intern:0,layer:0,lib:0,materi:0,model:0,object:0,open:0,physic:0,plant:0,polyhedron:0,structur:0,surfac:0,tabl:0,thermal:0,tree:0,usag:0,welcom:0,zone:0}})