geovista.report

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

Notes

Added in version 0.4.0.

Module Contents

Classes

Report

Generate an environment package and hardware report.

Attributes

NCOL	Default number of package columns in report HTML table.
PACKAGES_CORE	The core packages of geovista to include in the environment report.
PACKAGES_OPTIONAL	The optional packages of geovista to include in the environment report.
PackageLike	Type alias for a package module or package name.
TEXT_WIDTH	Default text width of non-HTML report.

class geovista.report.Report(additional=None, ncol=None, text_width=None, gpu=True)

Bases: scooby.Report

Generate an environment package and hardware report.

Notes

Added in version 0.4.0.

Generate an environment package and hardware report.

Parameters:

additionalPackageLike or list of PackageLike, optional

Extra package modules or package names to include in the report.

ncolint, optional

The number of package columns in a HTML table report. Defaults to NCOL.

text_widthint, optional

The number of character columns in a non-HTML report. Defaults to TEXT_WIDTH.

gpubool, optional

Detect GPU hardware details. Defaults to True. Disable this option if experiencing rendering issues to ensure report generation.

Notes

Added in version 0.4.0.

core

optional

geovista.report.NCOL: int = 3

Default number of package columns in report HTML table.

geovista.report.PACKAGES_CORE: list[str] = ['cartopy', 'click', 'click-default-group', 'cmocean', 'colorcet', 'geovista', 'matplotlib',...

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

geovista.report.PACKAGES_OPTIONAL: list[str] = ['IPython', 'PyQt5', 'fastparquet', 'imageio', 'ipywidgets', 'jupyter_server_proxy',...

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

geovista.report.PackageLike: TypeAlias = ModuleType | str

Type alias for a package module or package name.

geovista.report.TEXT_WIDTH: int = 88

Default text width of non-HTML report.