dragonfly-schema 1.9.9__py2.py3-none-any.whl → 1.10.0__py2.py3-none-any.whl

dragonfly_schema/model.py

@@ -3,7 +3,7 @@ from pydantic import BaseModel, Field, root_validator, constr, conlist
 from typing import List, Union
 
 from honeybee_schema._base import IDdBaseModel
-from honeybee_schema.model import Face3D, Units
+from honeybee_schema.model import Room, Face3D, Units
 from honeybee_schema.boundarycondition import Ground, Outdoors, Surface, \
     Adiabatic, OtherSideTemperature
 from honeybee_schema.altnumber import Autocalculate
@@ -245,14 +245,33 @@ class Building(IDdBaseModel):
     type: constr(regex='^Building$') = 'Building'
 
     unique_stories: List[Story] = Field(
-        ...,
+        default=None,
         description='An array of unique dragonfly Story objects that together form '
         'the entire building. Stories should generally be ordered from lowest '
-        'floor to highest floor. Note that, if a given Story is repeated several '
-        'times over the height of the building, the unique story included in this '
+        'floor to highest floor, though this is not required. Note that, if a '
+        'given Story is repeated several times over the height of the building '
+        'and this is represented by the multiplier, the unique story included in this '
         'list should be the first (lowest) story of the repeated floors.'
     )
 
+    room_3ds: List[Room] = Field(
+        default=None,
+        description='An optional array of 3D Honeybee Room objects for additional '
+        'Rooms that are a part of the Building but are not represented within '
+        'the unique_stories. This is useful when there are parts of the Building '
+        'geometry that cannot easily be represented with the extruded floor '
+        'plate and sloped roof assumptions that underlie Dragonfly Room2Ds '
+        'and RoofSpecification. Cases where this input is most useful include '
+        'sloped walls and certain types of domed roofs that become tedious to '
+        'implement with RoofSpecification. Matching the Honeybee Room.story '
+        'property to the Dragonfly Story.display_name of an object within the '
+        'unique_stories will effectively place the Honeybee Room on that Story '
+        'for the purposes of floor_area, exterior_wall_area, etc. However, note '
+        'that the Honeybee Room.multiplier property takes precedence over '
+        'whatever multiplier is assigned to the Dragonfly Story that the '
+        'Room.story may reference. (Default: None).'
+    )
+
     properties: BuildingPropertiesAbridged = Field(
         ...,
         description='Extension properties for particular simulation engines '

{dragonfly_schema-1.9.9.dist-info → dragonfly_schema-1.10.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dragonfly-schema
-Version: 1.9.9
+Version: 1.10.0
 Summary: Dragonfly Data-Model Objects
 Home-page: https://github.com/ladybug-tools/dragonfly-schema
 Author: Ladybug Tools
@@ -10,7 +10,7 @@ Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Operating System :: OS Independent
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: honeybee-schema (==1.57.0)
+Requires-Dist: honeybee-schema (==1.57.1)
 
 [![Build Status](https://travis-ci.com/ladybug-tools/dragonfly-schema.svg?branch=master)](https://travis-ci.com/ladybug-tools/dragonfly-schema)
 [![Coverage Status](https://coveralls.io/repos/github/ladybug-tools/dragonfly-schema/badge.svg?branch=master)](https://coveralls.io/github/ladybug-tools/dragonfly-schema)

{dragonfly_schema-1.9.9.dist-info → dragonfly_schema-1.10.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 dragonfly_schema/__init__.py,sha256=Cp-YAOlfQuotiRooL-u9oPbSK_C4xBDYQUhlA67qxyI,36
-dragonfly_schema/model.py,sha256=aCyDbpKnBYI4Bizi9Ov69zWAvA1djstxwQmMu7yThZU,13445
+dragonfly_schema/model.py,sha256=5csU2bUFi73ALNEeLh3ZQ0G-3wzezlnqIAfrLDeCd-g,14692
 dragonfly_schema/roof.py,sha256=hES6EXVl3utiKVhMnRSIGjnH4wCaa840PWjdd1YffkY,745
 dragonfly_schema/shading_parameter.py,sha256=WI9XPX3eVXhIutvE_AD1ozJ4QxH85E3Frv9SKsIzCl8,3121
 dragonfly_schema/skylight_parameter.py,sha256=4uxsAHHEbpfZYndIw2KcQ9AJXU7AJcRZWo7up65vC2c,3137
@@ -9,8 +9,8 @@ dragonfly_schema/energy/properties.py,sha256=x7wJqW9kPVMapa9lhIhsmMe_9IDYSWjN-H7
 dragonfly_schema/radiance/__init__.py,sha256=ok8w16ru1XXBUVjdghvNvwwXGPVSKKpHU-nmj4mf3IU,57
 dragonfly_schema/radiance/gridpar.py,sha256=ZQTnEdN1vmSsa2QMxfUdebg3cMnu6VvfcluiP11xHOs,4809
 dragonfly_schema/radiance/properties.py,sha256=Q_O_7fJohdtv5uwHTCZp1W67LoNUaZ45GB6GK7zKK4Y,3405
-dragonfly_schema-1.9.9.dist-info/LICENSE,sha256=XfAFIvGuzrC7DEE82mZyAJX4l2ND-i7fICCCMiXBDZw,1070
-dragonfly_schema-1.9.9.dist-info/METADATA,sha256=drgqPZCticXVtbC-RkqfziJbDuCETHEoH9WzmADj3JQ,1818
-dragonfly_schema-1.9.9.dist-info/WHEEL,sha256=unfA4MOaH0icIyIA5oH6E2sn2Hq5zKtLlHsWapZGwes,110
-dragonfly_schema-1.9.9.dist-info/top_level.txt,sha256=FOvFqYP_bZgcwNtIIgvUZjC-LuQGBEms5zW4nkiclZ0,17
-dragonfly_schema-1.9.9.dist-info/RECORD,,
+dragonfly_schema-1.10.0.dist-info/LICENSE,sha256=XfAFIvGuzrC7DEE82mZyAJX4l2ND-i7fICCCMiXBDZw,1070
+dragonfly_schema-1.10.0.dist-info/METADATA,sha256=ccjyaOEYAoS9KnlevrO7yloMbPpXt8-lvh9E_yneyyY,1819
+dragonfly_schema-1.10.0.dist-info/WHEEL,sha256=unfA4MOaH0icIyIA5oH6E2sn2Hq5zKtLlHsWapZGwes,110
+dragonfly_schema-1.10.0.dist-info/top_level.txt,sha256=FOvFqYP_bZgcwNtIIgvUZjC-LuQGBEms5zW4nkiclZ0,17
+dragonfly_schema-1.10.0.dist-info/RECORD,,