voxcity 0.5.22__tar.gz → 0.5.23__tar.gz

{voxcity-0.5.22 → voxcity-0.5.23}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: voxcity
-Version: 0.5.22
+Version: 0.5.23
 Summary: voxcity is an easy and one-stop tool to output 3d city models for microclimate simulation by integrating multiple geospatial open-data
 Author-email: Kunihiko Fujiwara <kunihiko@nus.edu.sg>
 Maintainer-email: Kunihiko Fujiwara <kunihiko@nus.edu.sg>
@@ -64,10 +64,11 @@ Dynamic: license-file
 [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1Lofd3RawKMr6QuUsamGaF48u2MN0hfrP?usp=sharing)
 [![License](https://img.shields.io/pypi/l/voxcity.svg)](https://pypi.org/project/voxcity/)
 [![Downloads](https://pepy.tech/badge/voxcity)](https://pepy.tech/project/voxcity)
+[![Documentation Status](https://readthedocs.org/projects/voxcity/badge/?version=latest)](https://voxcity.readthedocs.io/en/latest/?badge=latest)
 <!-- [![License: CC BY-SA 4.0](https://licensebuttons.net/l/by-sa/4.0/80x15.png)](https://creativecommons.org/licenses/by-sa/4.0/) -->
 
 <p align="center">
-  Tutorial preview: <a href="https://colab.research.google.com/drive/1Lofd3RawKMr6QuUsamGaF48u2MN0hfrP?usp=sharing">[Google Colab]</a>
+  Tutorial preview: <a href="https://colab.research.google.com/drive/1Lofd3RawKMr6QuUsamGaF48u2MN0hfrP?usp=sharing">[Google Colab]</a> | Documentation: <a href="https://voxcity.readthedocs.io/en/latest">[Read the Docs]</a>
 </p>
 
 <p align="center">
@@ -76,7 +77,7 @@ Dynamic: license-file
 
 # VoxCity
 
-**voxcity** is a Python package that provides a seamless solution for grid-based 3D city model generation and urban simulation for cities worldwide. VoxCity's generator module automatically downloads building heights, tree canopy heights, land cover, and terrain elevation within a specified target area, and voxelizes buildings, trees, land cover, and terrain to generate an integrated voxel city model. The simulator module enables users to conduct environmental simulations, including solar radiation and view index analyses. Users can export the generated models using several file formats compatible with external software, such as ENVI-met (INX), Blender, and Rhino (OBJ). Try it out using the [Google Colab Demo](https://colab.research.google.com/drive/1Lofd3RawKMr6QuUsamGaF48u2MN0hfrP?usp=sharing) or your local environment.
+**voxcity** is a Python package that provides a seamless solution for grid-based 3D city model generation and urban simulation for cities worldwide. VoxCity's generator module automatically downloads building heights, tree canopy heights, land cover, and terrain elevation within a specified target area, and voxelizes buildings, trees, land cover, and terrain to generate an integrated voxel city model. The simulator module enables users to conduct environmental simulations, including solar radiation and view index analyses. Users can export the generated models using several file formats compatible with external software, such as ENVI-met (INX), Blender, and Rhino (OBJ). Try it out using the [Google Colab Demo](https://colab.research.google.com/drive/1Lofd3RawKMr6QuUsamGaF48u2MN0hfrP?usp=sharing) or your local environment. For detailed documentation, API reference, and tutorials, visit our [Read the Docs](https://voxcity.readthedocs.io/en/latest) page.
 
 <!-- <p align="center">
   <picture>

{voxcity-0.5.22 → voxcity-0.5.23}/README.md

@@ -3,10 +3,11 @@
 [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1Lofd3RawKMr6QuUsamGaF48u2MN0hfrP?usp=sharing)
 [![License](https://img.shields.io/pypi/l/voxcity.svg)](https://pypi.org/project/voxcity/)
 [![Downloads](https://pepy.tech/badge/voxcity)](https://pepy.tech/project/voxcity)
+[![Documentation Status](https://readthedocs.org/projects/voxcity/badge/?version=latest)](https://voxcity.readthedocs.io/en/latest/?badge=latest)
 <!-- [![License: CC BY-SA 4.0](https://licensebuttons.net/l/by-sa/4.0/80x15.png)](https://creativecommons.org/licenses/by-sa/4.0/) -->
 
 <p align="center">
-  Tutorial preview: <a href="https://colab.research.google.com/drive/1Lofd3RawKMr6QuUsamGaF48u2MN0hfrP?usp=sharing">[Google Colab]</a>
+  Tutorial preview: <a href="https://colab.research.google.com/drive/1Lofd3RawKMr6QuUsamGaF48u2MN0hfrP?usp=sharing">[Google Colab]</a> | Documentation: <a href="https://voxcity.readthedocs.io/en/latest">[Read the Docs]</a>
 </p>
 
 <p align="center">
@@ -15,7 +16,7 @@
 
 # VoxCity
 
-**voxcity** is a Python package that provides a seamless solution for grid-based 3D city model generation and urban simulation for cities worldwide. VoxCity's generator module automatically downloads building heights, tree canopy heights, land cover, and terrain elevation within a specified target area, and voxelizes buildings, trees, land cover, and terrain to generate an integrated voxel city model. The simulator module enables users to conduct environmental simulations, including solar radiation and view index analyses. Users can export the generated models using several file formats compatible with external software, such as ENVI-met (INX), Blender, and Rhino (OBJ). Try it out using the [Google Colab Demo](https://colab.research.google.com/drive/1Lofd3RawKMr6QuUsamGaF48u2MN0hfrP?usp=sharing) or your local environment.
+**voxcity** is a Python package that provides a seamless solution for grid-based 3D city model generation and urban simulation for cities worldwide. VoxCity's generator module automatically downloads building heights, tree canopy heights, land cover, and terrain elevation within a specified target area, and voxelizes buildings, trees, land cover, and terrain to generate an integrated voxel city model. The simulator module enables users to conduct environmental simulations, including solar radiation and view index analyses. Users can export the generated models using several file formats compatible with external software, such as ENVI-met (INX), Blender, and Rhino (OBJ). Try it out using the [Google Colab Demo](https://colab.research.google.com/drive/1Lofd3RawKMr6QuUsamGaF48u2MN0hfrP?usp=sharing) or your local environment. For detailed documentation, API reference, and tutorials, visit our [Read the Docs](https://voxcity.readthedocs.io/en/latest) page.
 
 <!-- <p align="center">
   <picture>

{voxcity-0.5.22 → voxcity-0.5.23}/docs/Makefile

@@ -1,19 +1,19 @@
-# Minimal makefile for Sphinx documentation
-
-# You can set these variables from the command line.
-SPHINXOPTS    =
-SPHINXBUILD   = python -msphinx
-SPHINXPROJ    = voxcity
-SOURCEDIR     = .
-BUILDDIR      = _build
-
-# Put it first so that "make" without argument is like "make help".
-help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-.PHONY: help Makefile
-
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
+# Minimal makefile for Sphinx documentation
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = voxcity
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

{voxcity-0.5.22 → voxcity-0.5.23}/docs/conf.py

@@ -1,152 +1,126 @@
-# Configuration file for the Sphinx documentation builder.
-#
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-
-# -- Project information -----------------------------------------------------
-
-project = "voxcity"
-copyright = "2024, Kunihiko Fujiwara"
-author = "Kunihiko Fujiwara"
-
-# -- General configuration ---------------------------------------------------
-
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-nbsphinx_execute = "never"
-
-extensions = [
-    "myst_nb",
-    "autoapi.extension",
-    "sphinx.ext.napoleon",
-    "sphinx.ext.viewcode",
-    "sphinxcontrib.bibtex",
-]
-
-# Add these lines to configure myst-nb
-nb_execution_mode = "off"
-# myst_enable_extensions = [
-#     "amsmath",
-#     "colon_fence",
-#     "deflist",
-#     "dollarmath",
-#     "html_admonition",
-#     "html_image",
-#     "linkify",
-#     "replacements",
-#     "smartquotes",
-#     "substitution",
-#     "tasklist",
-# ]
-
-# Bibtex settings
-bibtex_bibfiles = ["references.bib"]
-bibtex_default_style = "plain"
-autoapi_dirs = ["../src"]
-
-autoapi_options = [
-    "members",
-    "undoc-members",
-    "show-inheritance",
-    "imported-members",
-    "special-members",
-    # "private-members",
-    "inherited-members",
-    "show-module-summary",
-]
-
-autoapi_own_page_level = "class"
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
-
-# -- Options for HTML output -------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-html_theme = "furo"
-
-# Theme options are theme-specific and customize the look and feel of a theme
-# further.  For a list of options available for each theme, see the
-# documentation.
-html_theme_options = {
-    "sidebar_hide_name": False,
-    "navigation_with_keys": True,
-    # "announcement": "This is a beta version of the documentation.",
-    "light_logo": "logo.png",
-    "dark_logo": "logo.png",
-}
-
-html_title = "VoxCity Documentation"
-# Remove or comment out the following line:
-# html_logo = "logo.png"
-html_favicon = "_static/favicon.ico"  # Make sure you have a favicon file
-
-# Add these lines near the other html_* configurations
-html_static_path = ["_static"]
-html_css_files = ["custom.css"]
-
-def skip_util_classes(app, what, name, obj, skip, options):
-    skip_packages = [
-        "mapillary",
-        "kartaview",
-        "classification",
-        "segmentation",
-        "low_level",
-        "depth_estimation",
-        "embeddings",
-        "object_detection"
-    ]
-    skip_modules = [
-        "base",
-        "font_property",
-        "gsv",
-        "ams",
-        "mly",
-        "kv",
-        "depth_estimation",
-        "embeddings",
-        "mly_metadata",
-        "image_to_pointcloud",
-        "transform_image",
-        "hist",
-        "image",
-        "kde",
-        "map",
-        "config"
-    ]
-    skip_classes = ["ImageDataset", "GSVDownloader", "Logger"]
-    skip_keywords = ["utils", "torchhub", "zoedepth", "depth_anything", "dinov2"]
-
-    if what == "package" and any(pkg in name for pkg in skip_packages):
-        return True
-    if what == "module" and any(mod in name for mod in skip_modules):
-        return True
-    if what == "class" and any(cls in name for cls in skip_classes):
-        return True
-    if any(keyword in name for keyword in skip_keywords):
-        return True
-    if what == "attribute":
-        return True
-
-    return skip
-
-
-def setup(app):
-    app.connect("autoapi-skip-member", skip_util_classes)
-    app.add_config_value(
-        "recommonmark_config",
-        {
-            "auto_toc_tree_section": "Contents",
-            "enable_eval_rst": True,
-        },
-        True,
-    )
-    app.add_transform(AutoStructify)
-
-
-# Add this new import at the top of the file
-from recommonmark.transform import AutoStructify
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+
+project = "voxcity"
+copyright = "2024, Kunihiko Fujiwara"
+author = "Kunihiko Fujiwara"
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+nbsphinx_execute = "never"
+
+extensions = [
+    "myst_nb",
+    "autoapi.extension",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+    "sphinxcontrib.bibtex",
+]
+
+# Add these lines to configure myst-nb
+nb_execution_mode = "off"
+
+# Bibtex settings
+bibtex_bibfiles = ["references.bib"]
+bibtex_default_style = "plain"
+autoapi_dirs = ["../src"]
+
+autoapi_options = [
+    "members",
+    "undoc-members",
+    "show-inheritance",
+    "imported-members",
+    "special-members",
+    # "private-members",
+    "inherited-members",
+    "show-module-summary",
+]
+
+autoapi_own_page_level = "class"
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = "furo"
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+html_theme_options = {
+    "sidebar_hide_name": False,
+    "navigation_with_keys": True,
+    # "announcement": "This is a beta version of the documentation.",
+    "light_logo": "logo.png",
+    "dark_logo": "logo.png",
+}
+
+html_title = "VoxCity Documentation"
+# Remove or comment out the following line:
+# html_logo = "logo.png"
+html_favicon = "_static/favicon.ico"  # Make sure you have a favicon file
+
+# Add these lines near the other html_* configurations
+html_static_path = ["_static"]
+html_css_files = ["custom.css"]
+
+def skip_util_classes(app, what, name, obj, skip, options):
+    skip_packages = [
+        "mapillary",
+        "kartaview",
+        "classification",
+        "segmentation",
+        "low_level",
+        "depth_estimation",
+        "embeddings",
+        "object_detection"
+    ]
+    skip_modules = [
+        "base",
+        "font_property",
+        "gsv",
+        "ams",
+        "mly",
+        "kv",
+        "depth_estimation",
+        "embeddings",
+        "mly_metadata",
+        "image_to_pointcloud",
+        "transform_image",
+        "hist",
+        "image",
+        "kde",
+        "map",
+        "config"
+    ]
+    skip_classes = ["ImageDataset", "GSVDownloader", "Logger"]
+    skip_keywords = ["utils", "torchhub", "zoedepth", "depth_anything", "dinov2"]
+
+    if what == "package" and any(pkg in name for pkg in skip_packages):
+        return True
+    if what == "module" and any(mod in name for mod in skip_modules):
+        return True
+    if what == "class" and any(cls in name for cls in skip_classes):
+        return True
+    if any(keyword in name for keyword in skip_keywords):
+        return True
+    if what == "attribute":
+        return True
+
+    return skip
+
+
+def setup(app):
+    app.connect("autoapi-skip-member", skip_util_classes)

{voxcity-0.5.22 → voxcity-0.5.23}/docs/make.bat

@@ -1,36 +1,36 @@
-@ECHO OFF
-
-pushd %~dp0
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=python -msphinx
-)
-set SOURCEDIR=.
-set BUILDDIR=_build
-set SPHINXPROJ=voxcity
-
-if "%1" == "" goto help
-
-%SPHINXBUILD% >NUL 2>NUL
-if errorlevel 9009 (
-	echo.
-	echo.The Sphinx module was not found. Make sure you have Sphinx installed,
-	echo.then set the SPHINXBUILD environment variable to point to the full
-	echo.path of the 'sphinx-build' executable. Alternatively you may add the
-	echo.Sphinx directory to PATH.
-	echo.
-	echo.If you don't have Sphinx installed, grab it from
-	echo.http://sphinx-doc.org/
-	exit /b 1
-)
-
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
-goto end
-
-:help
-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
-
-:end
-popd
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=python -msphinx
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+set SPHINXPROJ=voxcity
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The Sphinx module was not found. Make sure you have Sphinx installed,
+	echo.then set the SPHINXBUILD environment variable to point to the full
+	echo.path of the 'sphinx-build' executable. Alternatively you may add the
+	echo.Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

{voxcity-0.5.22 → voxcity-0.5.23}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "voxcity"
-version = "0.5.22"
+version = "0.5.23"
 requires-python = ">=3.10,<3.13"
 classifiers = [
     "Programming Language :: Python :: 3.10",