feat: set-up the recipe

.gitignore

@@ -0,0 +1,19 @@
+*.pyc
+test.py
+.pytest_cache
+*__pycache__
+.coverage
+*.ipynb
+.ipynb_checkpoints
+.tox
+*.egg-info
+tox.ini
+/.cache
+/.vscode
+.eggs
+*.code-workspace
+
+venv
+test.py
+dist/
+build/

.releaserc.json

@@ -0,0 +1,13 @@
+{
+    "plugins": [
+        "@semantic-release/commit-analyzer",
+        "@semantic-release/release-notes-generator",
+        "@semantic-release/github",
+        [
+            "@semantic-release/exec",
+            {
+                "publishCmd": "bash deploy.sh"
+            }
+        ]
+    ]
+}

LICENSE

@@ -0,0 +1,164 @@
+# PolyForm Shield License 1.0.0
+
+<https://polyformproject.org/licenses/shield/1.0.0>
+
+## Acceptance
+
+In order to get any license under these terms, you must agree
+to them as both strict obligations and conditions to all
+your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the
+software to do everything you might do with the software
+that would otherwise infringe the licensor's copyright
+in it for any permitted purpose.  However, you may
+only distribute the software according to [Distribution
+License](#distribution-license) and make changes or new works
+based on the software according to [Changes and New Works
+License](#changes-and-new-works-license).
+
+## Distribution License
+
+The licensor grants you an additional copyright license
+to distribute copies of the software.  Your license
+to distribute covers distributing the software with
+changes and new works permitted by [Changes and New Works
+License](#changes-and-new-works-license).
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of
+the software from you also gets a copy of these terms or the
+URL for them above, as well as copies of any plain-text lines
+beginning with `Required Notice:` that the licensor provided
+with the software.  For example:
+
+> Required Notice: Copyright Yoyodyne, Inc. (http://example.com)
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to
+make changes and new works based on the software for any
+permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that
+covers patent claims the licensor can license, or becomes able
+to license, that you would infringe by using the software.
+
+## Noncompete
+
+Any purpose is a permitted purpose, except for providing any
+product that competes with the software or any product the
+licensor or any of its affiliates provides using the software.
+
+## Competition
+
+Goods and services compete even when they provide functionality
+through different kinds of interfaces or for different technical
+platforms.  Applications can compete with services, libraries
+with plugins, frameworks with development tools, and so on,
+even if they're written in different programming languages
+or for different computer architectures.  Goods and services
+compete even when provided free of charge.  If you market a
+product as a practical substitute for the software or another
+product, it definitely competes.
+
+## New Products
+
+If you are using the software to provide a product that does
+not compete, but the licensor or any of its affiliates brings
+your product into competition by providing a new version of
+the software or another product using the software, you may
+continue using versions of the software available under these
+terms beforehand to provide your competing product, but not
+any later versions.
+
+## Discontinued Products
+
+You may begin using the software to compete with a product
+or service that the licensor or any of its affiliates has
+stopped providing, unless the licensor includes a plain-text
+line beginning with `Licensor Line of Business:` with the
+software that mentions that line of business.  For example:
+
+> Licensor Line of Business: YoyodyneCMS Content Management
+System (http://example.com/cms)
+
+## Sales of Business
+
+If the licensor or any of its affiliates sells a line of
+business developing the software or using the software
+to provide a product, the buyer can also enforce
+[Noncompete](#noncompete) for that product.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the
+law. These terms do not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of
+your licenses to anyone else, or prevent the licensor from
+granting licenses to anyone else.  These terms do not imply
+any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or
+contributes to infringement of any patent, your patent license
+for the software granted under these terms ends immediately. If
+your company makes such a claim, your patent license ends
+immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have
+violated any of these terms, or done anything with the software
+not covered by your licenses, your licenses can nonetheless
+continue if you come into full compliance with these terms,
+and take practical steps to correct past violations, within
+32 days of receiving notice.  Otherwise, all your licenses
+end immediately.
+
+## No Liability
+
+***As far as the law allows, the software comes as is, without
+any warranty or condition, and the licensor will not be liable
+to you for any damages arising out of these terms or the use
+or nature of the software, under any kind of legal claim.***
+
+## Definitions
+
+The **licensor** is the individual or entity offering these
+terms, and the **software** is the software the licensor makes
+available under these terms.
+
+A **product** can be a good or service, or a combination
+of them.
+
+**You** refers to the individual or entity agreeing to these
+terms.
+
+**Your company** is any legal entity, sole proprietorship,
+or other kind of organization that you work for, plus all
+its affiliates.
+
+**Affiliates** means the other organizations than an
+organization has control over, is under the control of, or is
+under common control with.
+
+**Control** means ownership of substantially all the assets of
+an entity, or the power to direct its management and policies
+by vote, contract, or otherwise.  Control can be direct or
+indirect.
+
+**Your licenses** are all the licenses granted to you for the
+software under these terms.
+
+**Use** means anything you do with the software requiring one
+of your licenses.

README.md

@@ -1,2 +1,4 @@
 # daylight-factor
 Daylight factor recipe for Pollination
+
+Use this recipe to calculate daylight factor for a HBJSON model.

deploy.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+echo "Building distribution"
+python setup.py sdist bdist_wheel
+echo "Pushing new version to PyPi"
+twine upload dist/* -u $PYPI_USERNAME -p $PYPI_PASSWORD

dev-requirements.txt

@@ -0,0 +1,4 @@
+pytest==6.2.2
+twine==3.3.0
+wheel==0.36.2
+setuptools==53.0.0

pollination/daylight_factor/__init__.py

@@ -0,0 +1,6 @@
+from .entry import DaylightFactorEntryPoint
+
+
+__pollination__ = {
+    'entry_point': DaylightFactorEntryPoint
+}

pollination/daylight_factor/_raytracing.py

@@ -0,0 +1,72 @@
+"""Raytracing DAG for daylight factor."""
+
+from pollination_dsl.dag import Inputs, DAG, task
+from dataclasses import dataclass
+
+from pollination.honeybee_radiance.grid import SplitGrid, MergeFiles
+from pollination.honeybee_radiance.raytrace import RayTracingDaylightFactor
+
+
+@dataclass
+class DaylightFactorRayTracing(DAG):
+    """Daylight factor-ray-tracing."""
+    # inputs
+
+    sensor_count = Inputs.int(
+        default=200,
+        description='The maximum number of grid points per parallel execution',
+        spec={'type': 'integer', 'minimum': 1}
+    )
+
+    radiance_parameters = Inputs.str(
+        description='The radiance parameters for ray tracing',
+        default='-ab 2'
+    )
+
+    octree_file = Inputs.file(
+        description='A Radiance octree file.',
+        extensions=['oct']
+    )
+
+    grid_name = Inputs.str(
+        description='Sensor grid file name. This is useful to rename the final result '
+        'file to {grid_name}.res'
+    )
+
+    sensor_grid = Inputs.file(
+        description='Sensor grid file.',
+        extensions=['pts']
+    )
+
+    @task(template=SplitGrid)
+    def split_grid(self, sensor_count=sensor_count, input_grid=sensor_grid):
+        return [
+            {'from': SplitGrid()._outputs.grids_list},
+            {'from': SplitGrid()._outputs.output_folder, 'to': 'sub_grids'}
+        ]
+
+    @task(
+        template=RayTracingDaylightFactor,
+        needs=[split_grid],
+        loop=split_grid._outputs.grids_list,
+        sub_folder='results',
+        sub_paths={'grid': '{{item.path}}'}
+    )
+    def ray_tracing(
+        self, radiance_parameters=radiance_parameters,
+        grid=split_grid._outputs.output_folder, scene_file=octree_file
+    ):
+        return [
+            {'from': RayTracingDaylightFactor()._outputs.result, 'to': '{{item.name}}.res'}
+        ]
+
+    @task(
+        template=MergeFiles, needs=[ray_tracing]
+    )
+    def merge_results(self, name=grid_name, extension='.res', folder='results'):
+        return [
+            {
+                'from': MergeFiles()._outputs.result_file,
+                'to': '../../results/{{self.name}}.res'
+            }
+        ]

pollination/daylight_factor/entry.py

@@ -0,0 +1,88 @@
+from typing import Dict, List
+from pollination_dsl.dag import Inputs, DAG, task, Outputs
+from dataclasses import dataclass
+from pollination.honeybee_radiance.sky import GenSkyWithCertainIllum
+from pollination.honeybee_radiance.octree import CreateOctreeWithSky
+from pollination.honeybee_radiance.translate import CreateRadianceFolder
+
+# input/output alias
+from pollination.alias.inputs.model import hbjson_model_input
+from pollination.alias.outputs.daylight import parse_daylight_factor_results
+
+from ._raytracing import DaylightFactorRayTracing
+
+
+@dataclass
+class DaylightFactorEntryPoint(DAG):
+    """Daylight factor entry point."""
+
+    # inputs
+    sensor_count = Inputs.int(
+        default=200,
+        description='The maximum number of grid points per parallel execution',
+        spec={'type': 'integer', 'minimum': 1}
+    )
+
+    radiance_parameters = Inputs.str(
+        description='The radiance parameters for ray tracing',
+        default='-ab 2'
+    )
+
+    model = Inputs.file(
+        description='A Honeybee model in HBJSON file format.',
+        extensions=['json', 'hbjson'],
+        alias=hbjson_model_input
+    )
+
+    @task(template=GenSkyWithCertainIllum)
+    def generate_sky(self) -> List[Dict]:
+        return [
+            {'from': GenSkyWithCertainIllum()._outputs.sky, 'to': 'resources/100000_lux.sky'}
+            ]
+
+    @task(template=CreateRadianceFolder)
+    def create_rad_folder(self, input_model=model) -> List[Dict]:
+        """Translate the input model to a radiance folder."""
+        return [
+            {'from': CreateRadianceFolder()._outputs.model_folder, 'to': 'model'},
+            {
+                'from': CreateRadianceFolder()._outputs.sensor_grids,
+                'description': 'Sensor grids information.'
+            }
+        ]
+
+    @task(
+        template=CreateOctreeWithSky, needs=[generate_sky, create_rad_folder]
+    )
+    def create_octree(
+        self, model=create_rad_folder._outputs.model_folder,
+        sky=generate_sky._outputs.sky
+    ):
+        """Create octree from radiance folder and sky."""
+        return [
+            {
+                'from': CreateOctreeWithSky()._outputs.scene_file,
+                'to': 'resources/scene.oct'
+            }
+        ]
+
+    @task(
+        template=DaylightFactorRayTracing,
+        needs=[create_rad_folder, create_octree],
+        loop=create_rad_folder._outputs.sensor_grids,
+        sub_folder='initial_results/{{item.name}}',  # create a subfolder for each grid
+        sub_paths={'sensor_grid': 'grid/{{item.name}}.pts'}  # sub_path for sensor_grid arg
+    )
+    def daylight_factor_ray_tracing(
+        self,
+        sensor_count=sensor_count,
+        radiance_parameters=radiance_parameters,
+        octree_file=create_octree._outputs.scene_file,
+        grid_name='{{item.name}}',
+        sensor_grid=create_rad_folder._outputs.model_folder
+    ):
+        # this task doesn't return a file for each loop.
+        # instead we access the results folder directly as an output
+        pass
+
+    results = Outputs.folder(source='results', alias=parse_daylight_factor_results)

requirements.txt

@@ -0,0 +1,2 @@
+pollination-honeybee-radiance>=0.4.5
+pollination-alias==0.1.0

setup.cfg

@@ -0,0 +1,5 @@
+[bdist_wheel]
+universal = 1
+
+[metadata]
+license_file = LICENSE