Merge pull request #6 from ni1o1/0.2.4

0.3.0

Author: ni1o1

README.md

@@ -30,7 +30,9 @@ Given a building GeoDataFrame and UTC datetime, `pybdshadow` can calculate the b
 ```python
 import pybdshadow
 #Given UTC datetime
-date = pd.to_datetime('2015-01-01 04:45:33.959797119')
+date = pd.to_datetime('2022-01-01 12:45:33.959797119')\
+    .tz_localize('Asia/Shanghai')\
+    .tz_convert('UTC')
 #Calculate building shadow for sun light
 shadows = pybdshadow.bdshadow_sunlight(buildings,date)
 ```

docs/source/analysis.rst

@@ -0,0 +1,64 @@
+.. _analysis:
+
+
+*****************************
+Shadow coverage analysis
+*****************************
+
+
+Shadow coverage analysis
+--------------------------------------
+
+.. function:: pybdshadow.cal_sunshadows(buildings, cityname='somecity', dates=['2022-01-01'], gap=3600,roof=True, include_building=True,save_shadows=False,printlog=False)
+
+Calculate the sunlight shadow in different date with given time gap.
+
+**Parameters**
+
+buildings : GeoDataFrame
+    Buildings. coordinate system should be WGS84
+cityname : string
+    Cityname. If save_shadows, this function will create `result/cityname` folder to save the shadows
+dates : list
+    list of dates
+gap : number
+    time gap(s)
+roof : bool
+    whether to calculate roof shadow.
+include_building : bool
+    whether the shadow include building outline
+save_shadows : bool
+    whether to save calculated shadows
+printlog : bool
+    whether to print log
+
+**Return**
+
+allshadow : GeoDataFrame
+    All building shadows calculated
+
+
+.. function:: pybdshadow.cal_shadowcoverage(shadows_input,buildings,roof=True,gap = 3600,accuracy=1)
+
+Calculate the sunlight shadow coverage time for given area.
+
+**Parameters**
+
+shadows_input : GeoDataFrame
+    All building shadows calculated
+buildings : GeoDataFrame
+    Buildings. coordinate system should be WGS84
+roof : bool
+    If true roof shadow, false then ground shadow
+gap : number
+    time gap(s), which is for calculation of coverage time
+accuracy : number
+    size of grids.
+
+**Return**
+
+bdgrids : GeoDataFrame
+    grids generated by TransBigData in study area, each grids have a `time` column store the shadow coverage time
+
+
+

docs/source/conf.py

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

docs/source/index.rst

@@ -62,4 +62,5 @@ Citation information can be found at https://github.com/ni1o1/pybdshadow/blob/ma
 
    preprocess.rst
    bdshadow.rst
+   analysis.rst
    Visualization.rst

example/example-analysis.ipynb

@@ -3,4 +3,5 @@ geopandas
 matplotlib
 suncalc
 keplergl
-scikit-opt
+scikit-opt
+transbigdata

example/example-calculation.ipynb

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="pybdshadow",
-    version="0.2.3",
+    version="0.3.0",
     author="Qing Yu",
     author_email="[email protected]",
     description="Python package to generate building shadow geometry",
@@ -17,7 +17,7 @@
         "Bug Tracker": "https://github.com/ni1o1/pybdshadow/issues",
     },
     install_requires=[
-        "numpy", "pandas", "shapely", "geopandas", "matplotlib","suncalc","keplergl"
+        "numpy", "pandas", "shapely", "geopandas", "matplotlib","suncalc","keplergl","transbigdata"
     ],
     classifiers=[
         "Operating System :: OS Independent",