geovista.report
===============

.. py:module:: geovista.report

.. autoapi-nested-parse::

   Generate an environment report of the Python packages and GPU hardware resources.

   Notes
   -----
   .. versionadded:: 0.4.0

   ..
       !! processed by numpydoc !!


Attributes
----------

.. autoapisummary::

   geovista.report.NCOL
   geovista.report.PACKAGES_CORE
   geovista.report.PACKAGES_OPTIONAL
   geovista.report.PackageLike
   geovista.report.TEXT_WIDTH


Classes
-------

.. autoapisummary::

   geovista.report.Report


Module Contents
---------------

.. py:class:: Report(*, additional = None, ncol = None, text_width = None, sort = True, gpu = True)

   Bases: :py:obj:`scooby.Report`


   Generate an environment package and hardware report.

   Notes
   -----
   .. versionadded:: 0.4.0



   Generate an environment package and hardware report.


   :Parameters:

       **additional** : :obj:`PackageLike` or :class:`python:list` of :obj:`PackageLike`, optional
           Extra package modules or package names to include in the report.

       **ncol** : :class:`python:int`, optional
           The number of package columns in a HTML table report. Defaults to
           :data:`NCOL`.

       **text_width** : :class:`python:int`, optional
           The number of character columns in a non-HTML report. Defaults to
           :data:`TEXT_WIDTH`.

       **sort** : :class:`python:bool`, optional
           Alphabetically sort the packages. Defaults to ``True``.

       **gpu** : :class:`python:bool`, optional
           Detect GPU hardware details. Defaults to ``True``. Disable this option if
           experiencing rendering issues to ensure report generation.











   .. rubric:: Notes

   .. versionadded:: 0.4.0



   ..
       !! processed by numpydoc !!


.. py:data:: NCOL
   :type:  int
   :value: 3


   
   Default number of package columns in report HTML table.
















   ..
       !! processed by numpydoc !!

.. py:data:: PACKAGES_CORE
   :type:  list[str]
   :value: ['cartopy', 'click', 'click-default-group', 'cmocean', 'colorcet', 'geopy', 'geovista',...


   
   The core packages of geovista to include in the environment report.
















   ..
       !! processed by numpydoc !!

.. py:data:: PACKAGES_OPTIONAL
   :type:  list[str]
   :value: ['fastparquet', 'h3', 'pandas', 'pyqt', 'pyvistaqt', 'rasterio', 'ipython', 'imageio', 'meshio',...


   
   The optional packages of geovista to include in the environment report.
















   ..
       !! processed by numpydoc !!

.. py:type:: PackageLike
   :canonical: str | types.ModuleType


   
   Type alias for a package module or package name.
















   ..
       !! processed by numpydoc !!

.. py:data:: TEXT_WIDTH
   :type:  int
   :value: 88


   
   Default text width of non-HTML report.
















   ..
       !! processed by numpydoc !!