pypsa.describe_options

pypsa.describe_options(prefix: str = '') → None

Print documentation for all options.

Parameters:

prefix (str) – Prefix for the option path. Used for nested options. If empty, the root options are printed.

Examples

Print only params.statistics options:

>>> pypsa.options.params.statistics.describe_options()
PyPSA Options
=============
drop_zero:
    Default: True
    Description: Default value for the 'drop_zero' parameter in statistics module.
nice_names:
    Default: True
    Description: Default value for the 'nice_names' parameter in statistics module.
round:
    Default: 5
    Description: Default value for the 'round' parameter in statistics module.

Or print all options: >>> pypsa.options.describe_options() PyPSA Options ============= api.legacy_components:

Default: True Description: WARNING: Experimental feature. Not all PyPSA functionality is supported yet. Use legacy components API for backwards compatibility to PyPSA versions prior to 1.0.0. It is still recommended to use the new API and not to rely on the legacy API. This option will be removed with PyPSA 2.0.0.

general.allow_network_requests:

Default: True Description: Allow PyPSA to make network requests. When False, all network requests (such as checking for version updates) are disabled. This may be needed in restricted environments, offline usage, or for security/privacy reasons. This only controls PyPSA’s own network requests, dependencies may still make network requests independently.

params.statistics.drop_zero:

Default: True Description: Default value for the ‘drop_zero’ parameter in statistics module.

params.statistics.nice_names:

Default: True Description: Default value for the ‘nice_names’ parameter in statistics module.

params.statistics.round:

Default: 5 Description: Default value for the ‘round’ parameter in statistics module.

warnings.components_store_iter:

Default: True Description: If False, suppresses the deprecatio warning when iterating over components.