update

docs/source/bdshadow.rst

@@ -9,7 +9,7 @@ Building shadow
 Shadow from sunlight
 --------------------------------------
 
-.. function:: pybdshadow.bdshadow_sunlight(buildings, date, merge=False, height='height', ground=0)
+.. function:: pybdshadow.bdshadow_sunlight(buildings, date,  height='height', roof=False,include_building = True,ground=0)
 
 Calculate the sunlight shadow of the buildings.
 
@@ -19,10 +19,12 @@ buildings : GeoDataFrame
     Buildings. coordinate system should be WGS84
 date : datetime
     Datetime
-merge : bool
-    whether to merge the wall shadows into the building shadows
 height : string
     Column name of building height
+roof : bool
+    whether to calculate the roof shadows
+include_building : bool
+    whether the shadow include building outline
 ground : number
     Height of the ground
 

docs/source/conf.py

@@ -22,8 +22,8 @@
 author = 'Qing Yu'
 
 # The full version, including alpha/beta/rc tags
-release = '0.2.2'
-version = '0.2.2'
+release = '0.2.3'
+version = '0.2.3'
 html_logo = "_static/logo-wordmark-light.png"
 html_favicon = '_static/logo.ico'
 # -- General configuration ---------------------------------------------------

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="pybdshadow",
-    version="0.2.2",
+    version="0.2.3",
     author="Qing Yu",
     author_email="[email protected]",
     description="Python package to generate building shadow geometry",

src/pybdshadow/__init__.py

@@ -32,7 +32,7 @@
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 """
 
-__version__ = '0.2.2'
+__version__ = '0.2.3'
 __author__ = 'Qing Yu <[email protected]>'
 
 # module level doc-string

src/pybdshadow/pybdshadow.py

@@ -82,6 +82,7 @@ def bdshadow_sunlight(buildings, date,  height='height', roof=False,include_buil
     Calculate the sunlight shadow of the buildings.
 
     **Parameters**
+
     buildings : GeoDataFrame
         Buildings. coordinate system should be WGS84
     date : datetime
@@ -96,6 +97,7 @@ def bdshadow_sunlight(buildings, date,  height='height', roof=False,include_buil
         Height of the ground
 
     **Return**
+
     shadows : GeoDataFrame
         Building shadow
     '''
@@ -264,6 +266,7 @@ def bdshadow_pointlight(buildings,
     Calculate the sunlight shadow of the buildings.
 
     **Parameters**
+    
     buildings : GeoDataFrame
         Buildings. coordinate system should be WGS84
     pointlon,pointlat,pointheight : float
@@ -278,6 +281,7 @@ def bdshadow_pointlight(buildings,
         Height of the ground
 
     **Return**
+
     shadows : GeoDataFrame
         Building shadow
     '''