Tip

1. Need help? Please let us know in the SUEWS Community.

2. Please report issues with the manual on GitHub Issues (or use Report Issue for This Page for page-specific feedback).

3. Please cite SUEWS with proper information from our Zenodo page.

6.2.1.6. supy.show_version

supy.show_version(mode='simple', as_json=False)

Display SUEWS version and system dependency information.

This function prints version information for SuPy and optionally for system dependencies. Output can be displayed as plain text or exported as JSON.

Parameters:

• mode (str, optional) –

  Display mode for version information. Options are:

  • ’simple’ (default): Print only the SuPy version number

  • ’full’: Print SuPy version and complete system dependency information

• as_json (bool or str, optional) –

  Controls JSON output format. Options are:

  • False (default): Display as plain text

  • True: Print version information as JSON to stdout

  • str: Path to JSON file where version information will be saved

  When a file path is provided, the function appends SuPy version information to pandas system information in the specified file.

Returns:

This function prints to stdout or writes to file; it does not return a value.

Return type:

None

Raises:

ValueError – If mode is not ‘simple’ or ‘full’.

Examples

Display simple version information:

>>> import supy as sp
>>> sp.show_version()
2025.6.2.dev99

Display full version and system information:

>>> sp.show_version(mode="full")
SUEWS VERSION: 2025.6.2.dev99
-------------

SYSTEM DEPENDENCY [System dependency information follows…]

Export version information to JSON:

>>> sp.show_version(as_json="version_info.json")

Notes

The full mode leverages pandas.show_versions() to display comprehensive information about installed dependencies, which is useful for debugging and issue reporting.

When using JSON output with a file path, the function reads existing pandas version information and prepends SuPy-specific version data.

See also

pandas.show_versions

Display pandas version and dependency information