pybdshadow 0.1.1

Python package to generate building shadow geometry

pybdshadow

Introduction

pybdshadow is a python package to generate building shadow geometry. The latest stable release of the software can be installed via pip and full documentation can be found here.

Example

Given a building GeoDataFrame and UTC datetime, pybdshadow can calculate the building shadow based on the sun position obtained by suncalc

import pybdshadow
#Given UTC datetime
date = pd.to_datetime('2015-01-01 02:45:33.959797119')
#Calculate building shadow
shadows = pybdshadow.bdshadow_sunlight(buildings,date)

pybdshadow also provide visualization method supported by keplergl.

# visualize buildings and shadows
pybdshadow.show_bdshadow(buildings = buildings,shadows = shadows)

Detail usage can be found in this example.

Installation

It is recommended to use Python 3.7, 3.8, 3.9

Using pypi

pybdshadow can be installed by using pip install. Before installing pybdshadow, make sure that you have installed the available geopandas package. If you already have geopandas installed, run the following code directly from the command prompt to install pybdshadow:

pip install pybdshadow

Dependency

pybdshadow depends on the following packages

• numpy
• pandas
• shapely
• rtree
• geopandas
• matplotlib
• suncalc
• keplergl (optional)

Citation information

Citation information can be found at CITATION.cff.