dragonfly-radiance 0.4.121__py3-none-any.whl

dragonfly_radiance/properties/story.py

@@ -0,0 +1,122 @@
+# coding=utf-8
+"""Story Radiance Properties."""
+from honeybee_radiance.modifierset import ModifierSet
+
+from honeybee_radiance.lib.modifiersets import generic_modifier_set_visible
+
+
+class StoryRadianceProperties(object):
+    """Radiance Properties for Dragonfly Story.
+
+    Args:
+        host: A dragonfly_core Story object that hosts these properties.
+        modifier_set: A honeybee ModifierSet object to specify all default modifiers
+            for the Story geometry. If None, it will be the honeybee default modifier
+            set, which is only representative of typical indoor conditions in
+            the visible spectrum. (Default: None).
+
+    Properties:
+        * host
+        * modifier_set
+    """
+
+    __slots__ = ('_host', '_modifier_set')
+
+    def __init__(self, host, modifier_set=None):
+        """Initialize Story radiance properties."""
+        self._host = host
+        self.modifier_set = modifier_set
+
+    @property
+    def host(self):
+        """Get the Story object hosting these properties."""
+        return self._host
+
+    @property
+    def modifier_set(self):
+        """Get or set the Story ModifierSet object.
+
+        If not set, it will be set by the parent Building or will be the Honeybee
+        default generic ModifierSet.
+        """
+        if self._modifier_set is not None:  # set by the user
+            return self._modifier_set
+        elif self._host.has_parent:  # set by parent building
+            return self._host.parent.properties.radiance.modifier_set
+        else:
+            return generic_modifier_set_visible
+
+    @modifier_set.setter
+    def modifier_set(self, value):
+        if value is not None:
+            assert isinstance(value, ModifierSet), \
+                'Expected ModifierSet. Got {}'.format(type(value))
+            value.lock()   # lock in case modifier set has multiple references
+        self._modifier_set = value
+
+    @classmethod
+    def from_dict(cls, data, host):
+        """Create StoryRadianceProperties from a dictionary.
+
+        Note that the dictionary must be a non-abridged version for this
+        classmethod to work.
+
+        Args:
+            data: A dictionary representation of StoryRadianceProperties.
+            host: A Story object that hosts these properties.
+        """
+        assert data['type'] == 'StoryRadianceProperties', \
+            'Expected StoryRadianceProperties. Got {}.'.format(data['type'])
+
+        new_prop = cls(host)
+        if 'modifier_set' in data and data['modifier_set'] is not None:
+            new_prop.modifier_set = ModifierSet.from_dict(data['modifier_set'])
+
+        return new_prop
+
+    def apply_properties_from_dict(self, abridged_data, modifier_sets):
+        """Apply properties from a StoryRadiancePropertiesAbridged dictionary.
+
+        Args:
+            abridged_data: A StoryRadiancePropertiesAbridged dictionary (typically
+                coming from a Model).
+            modifier_sets: A dictionary of ModifierSets with identifiers
+                of the sets as keys, which will be used to re-assign modifier_sets.
+        """
+        if 'modifier_set' in abridged_data and abridged_data['modifier_set'] is not None:
+            self.modifier_set = modifier_sets[abridged_data['modifier_set']]
+
+    def to_dict(self, abridged=False):
+        """Return Story Radiance properties as a dictionary.
+
+        Args:
+            abridged: Boolean for whether the full dictionary of the Story should
+                be written (False) or just the identifier of the the individual
+                properties (True). Default: False.
+        """
+        base = {'radiance': {}}
+        base['radiance']['type'] = 'StoryRadianceProperties' if not \
+            abridged else 'StoryRadiancePropertiesAbridged'
+
+        # write the ModifierSet into the dictionary
+        if self._modifier_set is not None:
+            base['radiance']['modifier_set'] = \
+                self._modifier_set.identifier if abridged else \
+                self._modifier_set.to_dict()
+
+        return base
+
+    def duplicate(self, new_host=None):
+        """Get a copy of this object.
+
+        new_host: A new Story object that hosts these properties.
+            If None, the properties will be duplicated with the same host.
+        """
+        _host = new_host or self._host
+        return StoryRadianceProperties(_host, self._modifier_set)
+
+    def ToString(self):
+        return self.__repr__()
+
+    def __repr__(self):
+        return 'Story Radiance Properties: {}'.format(self.host.identifier)

dragonfly_radiance-0.4.121.dist-info/METADATA

@@ -0,0 +1,85 @@
+Metadata-Version: 2.4
+Name: dragonfly-radiance
+Version: 0.4.121
+Summary: Dragonfly extension for radiance simulation.
+Home-page: https://github.com/ladybug-tools/dragonfly-radiance
+Author: Ladybug Tools
+Author-email: info@ladybug.tools
+License: AGPL-3.0
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: IronPython
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: dragonfly-core==1.74.22
+Requires-Dist: honeybee-radiance==1.66.217
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
+
+![Dragonfly](https://www.ladybug.tools/assets/img/dragonfly.png)
+
+[![Build Status](https://github.com/ladybug-tools/dragonfly-radiance/actions/workflows/ci.yaml/badge.svg)](https://github.com/ladybug-tools/dragonfly-radiance/actions)
+
+[![Python 3.10](https://img.shields.io/badge/python-3.10-orange.svg)](https://www.python.org/downloads/release/python-3100/) [![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/) [![Python 2.7](https://img.shields.io/badge/python-2.7-green.svg)](https://www.python.org/downloads/release/python-270/) [![IronPython](https://img.shields.io/badge/ironpython-2.7-red.svg)](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)
+
+# dragonfly-radiance
+
+Dragonfly extension for Radiance simulation.
+
+## Installation
+
+`pip install dragonfly-radiance`
+
+To check if the command line interface is installed correctly
+use `dragonfly-radiance --help`.
+
+## QuickStart
+
+```python
+import dragonfly_radiance
+```
+
+## [API Documentation](http://ladybug-tools.github.io/dragonfly-radiance/docs)
+
+## Local Development
+
+1. Clone this repo locally
+```
+git clone git@github.com:ladybug-tools/dragonfly-radiance
+
+# or
+
+git clone https://github.com/ladybug-tools/dragonfly-radiance
+```
+2. Install dependencies:
+```
+cd dragonfly-radiance
+pip install -r dev-requirements.txt
+pip install -r requirements.txt
+```
+
+3. Run Tests:
+```
+python -m pytest tests/
+```
+
+4. Generate Documentation:
+```
+sphinx-apidoc -f -e -d 4 -o ./docs ./dragonfly_radiance
+sphinx-build -b html ./docs ./docs/_build/docs
+```

dragonfly_radiance-0.4.121.dist-info/RECORD

@@ -0,0 +1,18 @@
+dragonfly_radiance/__init__.py,sha256=a5zhx2c8vxlpBs2Tw1jbiQxgVaB_2x3X9HIN2sfvOeM,244
+dragonfly_radiance/__main__.py,sha256=ly6FLNs9Rxq7G_TcItza_9faTXQ48nzZlXgXKd-2n_8,87
+dragonfly_radiance/_extend_dragonfly.py,sha256=eYxw_KAtcMBFQAlAFXOY_aUrWbeP-lsxAepMxyorquo,1965
+dragonfly_radiance/gridpar.py,sha256=3u04rncp2Oy-ckpwwvTAZbvriy8J560Vxk0fjCx-bNo,25643
+dragonfly_radiance/cli/__init__.py,sha256=7Zx_-nOm0gIioPH5XtVyrTfGPwzniTUF3vqcCp4RLn4,423
+dragonfly_radiance/cli/translate.py,sha256=zj04WUFk-WWV9zwAgKYUygoaaKgq84bceRAHljFhEgs,20674
+dragonfly_radiance/properties/__init__.py,sha256=h-O2WRFI5r12owvSQUrSgdLmlhM7shJAvzLFGryG3rk,37
+dragonfly_radiance/properties/building.py,sha256=nRjezCr7JLMD6fsmQhYBb2GNUtrgtKV2Tli8l9tJ1Fg,6283
+dragonfly_radiance/properties/context.py,sha256=WshH9BOhqbwvxmILRugTMfbvTMl8u5QzIETbJiORTUk,5250
+dragonfly_radiance/properties/model.py,sha256=4SWWq79zwQlBZJ6np7_i1vIj8Cvr9NCj7YhF5Z0cj_k,20197
+dragonfly_radiance/properties/room2d.py,sha256=I_JcNqOjhwov-U0wiFc9JeMmTX1Wukc-jPmU0khpEI4,9125
+dragonfly_radiance/properties/story.py,sha256=htHHyAh8tNdQCGJGMvbI9Xo3RAdHdC8JPE1fnEPY-44,4519
+dragonfly_radiance-0.4.121.dist-info/licenses/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
+dragonfly_radiance-0.4.121.dist-info/METADATA,sha256=6Yw_AbOuoGWo0wdksTR7bTpzLHKSlSa0grZegQi751k,2742
+dragonfly_radiance-0.4.121.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+dragonfly_radiance-0.4.121.dist-info/entry_points.txt,sha256=7KZdeDvrwJ-ZB0LiTJ3TBkYJAmLl6_uSXXhZnLGct4g,71
+dragonfly_radiance-0.4.121.dist-info/top_level.txt,sha256=uvkDZDtPEVgdj7rWsDAl4vcUIuWT7GFBBVmFK4pNE4s,19
+dragonfly_radiance-0.4.121.dist-info/RECORD,,

dragonfly_radiance-0.4.121.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

dragonfly_radiance-0.4.121.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+dragonfly-radiance = dragonfly_radiance.cli:radiance