honeybee.radiance.runmanager package

Submodules

honeybee.radiance.runmanager.runmanager module

Radiance Analysis workflows.

class honeybee.radiance.runmanager.runmanager.Runner(title, tasks)

Bases: object

Run manager for Radiance tasks.

execute(cpus=1, cwd=None, env=None, update_freq=5, verbose=True)

Execute all task groups.

class honeybee.radiance.runmanager.runmanager.TaskGroup(tasks=None)

Bases: object

A group of radiance tasks which will be executed in parallel.

execute(cpus=1, cwd=None, env=None, update_freq=5, verbose=True)

Execute tasks in this task group in parallel.

is_finished

progress

terminate()

Terminate task group.

honeybee.radiance.runmanager.task module

Radiance Task.

A task is a series of command that will be executed one after each other.

class honeybee.radiance.runmanager.task.SubTask(title, command, output_file=None, expected_output_size=None)

Bases: object

ToString()

Overwrite .NET ToString method.

command

List of command for this task.

cpu_demand

Number of cpus that this task will be using.

This number will always be 1 on Windows as radiance doesn’t support multi-processor calculation on Windows.

execute(cwd=None, env=None)

Execute command one after each other.

classmethod from_json(task_json)

Create a task from a dictionary.

{‘title’: self._title, ‘command’: self.command}

is_finished

is_running

is_started

is_succeed

progress

Progress as a percentage.

progress_report

Human readable progress report.

stderr

Return standard errors if any.

stdout

Return standard output if any.

terminate()

Terminate subtask.

title

SubTask title.

to_json()

Return a Task as a dictionary.

class honeybee.radiance.runmanager.task.Task(title, subtasks)

Bases: object

A collection of subtasks to be executed one after each other.

ToString()

Overwrite .NET ToString method.

count

Length of subtasks.

cpu_demand

Number of cpus that this task will be using.

This number will always be 1 on Windows as radiance doesn’t support multi-processor calculation on Windows.

execute(cwd=None, env=None, verbose=True, update_freq=5)

Execute this taskself.

This method is blocking and will wait until the execution is finished.

execute_next(cwd=None, env=None, verbose=True)

Execute next task in line.

execute_subtask(task_index, cwd=None, env=None, verbose=True)

classmethod from_json(task_json)

Create a task from a dictionary.

{‘title’: self._title, ‘subtasks’: [{}, {}]}

is_finished

Check if the execution of this task is finished.

is_running

is_succeed()

True if all subtasks are executed successfully.

progress_report

Return human readable progress of subtasks.

subtasks

List of subtasks.

terminate()

Terminate subtask.

title

SubTask title.

to_json()

Return a Task as a dictionary.

Module contents

Run manager for Radiance studies.