py4design package

Subpackages

• py4design.py2energyplus package
  • Submodules
    • py4design.py2energyplus.idf_writer module
  • Module contents
• py4design.py2radiance package
  • Submodules
    • py4design.py2radiance.write_rad module
  • Module contents
• py4design.py3dmodel package
  • Submodules
    • py4design.py3dmodel.calculate module
    • py4design.py3dmodel.construct module
    • py4design.py3dmodel.export_collada module
    • py4design.py3dmodel.fetch module
    • py4design.py3dmodel.modify module
    • py4design.py3dmodel.utility module
  • Module contents
    • Py3dmodel
      • Submodules
• py4design.pycitygml package
  • Submodules
    • py4design.pycitygml.write_gml module
  • Module contents
• py4design.pyoptimise package
  • Submodules
    • py4design.pyoptimise.analyse_xml module
    • py4design.pyoptimise.draw_graph module
    • py4design.pyoptimise.nsga2 module
  • Module contents
    • Pyoptimise
      • Submodules

Submodules

• py4design.analysisrulepalette module
• py4design.buildingformeval module
• py4design.citygml2eval module
• py4design.gml3dmodel module
• py4design.gmlparameterise module
• py4design.gmlparmpalette module
• py4design.massing2citygml module
• py4design.shapeattributes module
• py4design.shp2citygml module
• py4design.skyviewfactor module
• py4design.templaterulepalette module
• py4design.urbanformeval module
• py4design.urbangeom module
• py4design.utility module

Module contents

Py4design: Python Library for Rapid Development of Design Workflows (previously known as Pyliburo)

Documentation is available in the docstrings and online at http://chenkianwee.github.io/py4design/

Contents

Subpackages & Submodules

Using any of these subpackages requires an explicit import. For example, from py4design import py3dmodel.

py2energyplus                --- Python library to write idf file and execute energyplus
py2radiance                  --- Python library to write rad file and execute radiance/daysim
py3dmodel                    --- A wrapper of CAD Kernel PythonOCC, dependencies: PythonOCC, OCCUtils, scipy/numpy, pycollada
pycitygml                    --- Python library to read and write LOD1 Citygml 1.0, dependencies: lxml
pyoptimise                   --- Optimisation module currently includes NSGAII, dependencies: matplotlib, scikit-learn, pymf, cvxopt

Using any of these submodules requires an explicit import. For example, from py4design import utility.

analysisrulepalette          --- Base rules for converting geometrical to CityGML model (LOD1), uses subpackages: py3dmodel
buildingformeval             --- Functions for evaluating building forms, uses subpackages: py3dmodel, py2radiance, uses modules: utility, gml3dmodel
citygml2eval                 --- Evaluation of CityGML (LOD1) file, uses subpackages: pycitygml, py3dmodel, uses modules: gml3dmodel, urbanformeval
gml3dmodel                   --- Funcitons to process 3D geometries CityGML file (LOD1), uses subpackages: py3dmodel, pycitygml, uses modules: utility3d
gmlparameterise              --- Module for parameterising a CityGML model (LOD1), uses subpackages: pycitygml
gmlparmpalette               --- Base parameters for parameterisng a CityGML model (LOD1), uses subpackages: pycitygml, py3dmodel, uses modules: gml3dmodel, utility
massing2citygml              --- Convert a massing model into CityGML model (LOD1), dependencies: pycollada, uses subpackages: py3dmodel, pytcitygml, uses modules: gml3dmodel, shapeattributes
shapeattributes              --- A class to store attributes in geometries
shp2citygml                  --- Functions to convert shapefiles to CityGML models, dependencies: shapefile, uses subpackages: pycitygml, py3dmodel, uses modules: gml3dmodel
skyviewfactor                --- Functions to calculate sky view factor, uses subpackages: py3dmodel
templaterulepalette          --- Base template rules to convert geometrical to CityGML model (LOD1), uses subpackages: py3dmodel, uses modules: gml3dmodel
urbanformeval                --- Functions to evaluate urban forms, dependencies: networkx, uses subpackages: py3dmodel, py2radiance, uses modules: gml3dmodel
urbangeom                    --- Functions to process urban geometries, uses subpackages: py3dmodel
utility                      --- Utility functions