voxcity 0.6.31__py3-none-any.whl → 0.6.32__py3-none-any.whl

{voxcity-0.6.31.dist-info → voxcity-0.6.32.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: voxcity
-Version: 0.6.31
+Version: 0.6.32
 Summary: voxcity is an easy and one-stop tool to output 3d city models for microclimate simulation by integrating multiple geospatial open-data
 License: MIT
 License-File: AUTHORS.rst
@@ -247,14 +247,14 @@ kwargs = {
 
 ### 4. Get voxcity Output
 
-Generate voxel data grids and corresponding building geoJSON:
+Generate voxel data grids and a corresponding building GeoDataFrame:
 
 ```python
 from voxcity.generator import get_voxcity
 
 voxcity_grid, building_height_grid, building_min_height_grid, \
-building_id_grid, canopy_height_grid, canopy_bottom_height_grid, land_cover_grid, dem_grid, \
-building_gdf = get_voxcity(
+    building_id_grid, canopy_height_grid, canopy_bottom_height_grid, land_cover_grid, dem_grid, \
+    building_gdf = get_voxcity(
     rectangle_vertices,
     building_source,
     land_cover_source,
@@ -265,6 +265,10 @@ building_gdf = get_voxcity(
 )
 ```
 
+### Interactive 3D Demo (Plotly)
+
+- **Open interactive demo**: <a href="https://voxcity.readthedocs.io/en/latest/_static/plotly/voxcity_demo.html">Launch the Plotly 3D viewer</a>
+
 ### 5. Exporting Files
 
 #### ENVI-MET INX/EDB Files:
@@ -301,6 +305,7 @@ from voxcity.exporter.obj import export_obj
 
 output_directory = "output"  # Directory where output files will be saved
 output_file_name = "voxcity" # Base name for the output OBJ file
+# export_obj signature: export_obj(array, output_dir, file_name, voxel_size, voxel_color_map=None)
 export_obj(voxcity_grid, output_directory, output_file_name, meshsize)
 ```
 The generated OBJ files can be opened and rendered in the following 3D visualization software:
@@ -372,7 +377,7 @@ solar_grid = get_global_solar_irradiance_using_epw(
 # Adjust parameters for cumulative calculation
 solar_kwargs["start_time"] = "01-01 01:00:00" # Start time for cumulative calculation
 solar_kwargs["end_time"] = "01-31 23:00:00" # End time for cumulative calculation
-solar_kwargs["output_file_name"] = 'cummulative_solar_irradiance',  # Base filename for outputs (without extension)
+solar_kwargs["output_file_name"] = 'cumulative_solar_irradiance'  # Base filename for outputs (without extension)
 
 # Calculate cumulative solar irradiance over the specified time period
 cum_solar_grid = get_global_solar_irradiance_using_epw(    

{voxcity-0.6.31.dist-info → voxcity-0.6.32.dist-info}/RECORD

@@ -30,10 +30,10 @@ voxcity/simulator/view.py,sha256=k3FoS6gsibR-eDrTHJivJSQfvN3Tg8R8eSTeMqd9ans,939
 voxcity/utils/__init__.py,sha256=Q-NYCqYnAAaF80KuNwpqIjbE7Ec3Gr4y_khMLIMhJrg,68
 voxcity/utils/lc.py,sha256=722Gz3lPbgAp0mmTZ-g-QKBbAnbxrcgaYwb1sa7q8Sk,16189
 voxcity/utils/material.py,sha256=H8K8Lq4wBL6dQtgj7esUW2U6wLCOTeOtelkTDJoRgMo,10007
-voxcity/utils/visualization.py,sha256=zAq_3VxAE_Si9t8MfWsdBQPEVALsAGZoSRFjXgpGK7c,123942
+voxcity/utils/visualization.py,sha256=wmU0DCvYdq22RZH6zZXjt62M8pjZVSRU5Qppvv-Bj30,126848
 voxcity/utils/weather.py,sha256=cb6ZooL42Hc4214OtFiJ78cCgWYM6VE-DU8S3e-urRg,48449
-voxcity-0.6.31.dist-info/licenses/AUTHORS.rst,sha256=m82vkI5QokEGdcHof2OxK39lf81w1P58kG9ZNNAKS9U,175
-voxcity-0.6.31.dist-info/licenses/LICENSE,sha256=s_jE1Df1nTPL4A_5GCGic5Zwex0CVaPKcAmSilxJPPE,1089
-voxcity-0.6.31.dist-info/METADATA,sha256=ITJGlkmT7MeF972nAiy1kTejBtTWYJu2uFypeKF4JWA,27039
-voxcity-0.6.31.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
-voxcity-0.6.31.dist-info/RECORD,,
+voxcity-0.6.32.dist-info/licenses/AUTHORS.rst,sha256=m82vkI5QokEGdcHof2OxK39lf81w1P58kG9ZNNAKS9U,175
+voxcity-0.6.32.dist-info/licenses/LICENSE,sha256=s_jE1Df1nTPL4A_5GCGic5Zwex0CVaPKcAmSilxJPPE,1089
+voxcity-0.6.32.dist-info/METADATA,sha256=KBYd4SrDJJOxEJcN2is0oB4RBSVPt8QGfd6gGy-sg4s,27331
+voxcity-0.6.32.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+voxcity-0.6.32.dist-info/RECORD,,