Metadata-Version: 2.2
Name: tree_shade_mapper
Version: 0.1.2
Summary: Python package to calculate the shading effect of tree canopies from panoramic imagery
Author-email: Kunihiko Fujiwara <kunihiko@nus.edu.sg>
Maintainer-email: Kunihiko Fujiwara <kunihiko@nus.edu.sg>
License: CC-BY-SA-4.0
Project-URL: bugs, https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/issues
Project-URL: changelog, https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/blob/master/changelog.md
Project-URL: homepage, https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: AUTHORS.rst
Requires-Dist: zensvi
Requires-Dist: typer
Requires-Dist: pandas
Requires-Dist: pvlib
Requires-Dist: folium
Requires-Dist: branca
Requires-Dist: h3
Requires-Dist: seaborn
Requires-Dist: geopandas
Requires-Dist: shapely
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: contextily
Requires-Dist: pillow
Requires-Dist: scipy
Requires-Dist: opencv-python
Requires-Dist: pytz
Requires-Dist: scikit-learn
Provides-Extra: dev
Requires-Dist: coverage; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: ruff; extra == "dev"

=================
Tree Shade Mapper
=================

.. image:: https://img.shields.io/pypi/v/tree-shade-mapper.svg
        :target: https://pypi.python.org/pypi/tree-shade-mapper
        :alt: PyPI Version

.. image:: https://colab.research.google.com/assets/colab-badge.svg
   :target: https://colab.research.google.com/drive/1fUcqN6aSLGZnzzahIZiy_AkigFn5gY2e?usp=sharing
   :alt: Open In Colab

Python package to calculate the shading effect of tree canopies from panoramic imagery

* Free software: CC-BY-SA-4.0
* Documentation: https://tree_shade_mapper.readthedocs.io.

Features
--------

* TODO

Citation
--------

Please cite the paper_ if you use `Tree Shade Mapper` in a scientific publication:

.. _paper: https://doi.org/10.1016/j.buildenv.2024.112071

.. code-block:: bibtex

   @article{2024_bae_svf,
      author = {Fujiwara, Kunihiko and Ito, Koichi and Ignatius, Marcel and Biljecki, Filip},
      doi = {10.1016/j.buildenv.2024.112071},
      journal = {Building and Environment},
      pages = {112071},
      title = {A panorama-based technique to estimate sky view factor and solar irradiance considering transmittance of tree canopies},
      volume = {266},
      year = {2024}
   }

.. .. code-block:: bibtex

..    @article{ito2024zensvi,
..      title={ZenSVI: One-Stop Python Package for Integrated Analysis of Street View Imagery},
..      author={Ito, Koichi, XXX, XXX, XXX, ...},
..      journal={XXX},
..      volume={XXX},
..      pages={XXX},
..      year={2024}
..    }

Credits
-------

This package uses `ZenSVI` for semantic segmentation.
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _ZenSVI: https://github.com/koito19960406/ZenSVI
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
