pysiral

pysiral is the PYthon Sea Ice Radar ALtimetry toolbox

Submodules

Attributes

__version__

__git_version__

__git_branch__

__git_origin__

psrlcfg

Functions

get_cls(module_name, class_name[, relaxed])

Small helper function to dynamically load classes

import_submodules(package[, recursive])

Import all submodules of a module, recursively, including subpackages

set_psrl_cpu_count(→ None)

Set the pysiral-wide CPU count for multiprocessing to the pysiral package

Package Contents

pysiral.__version__
pysiral.__git_version__
pysiral.__git_branch__
pysiral.__git_origin__
pysiral.psrlcfg
pysiral.get_cls(module_name, class_name, relaxed=True)

Small helper function to dynamically load classes

pysiral.import_submodules(package, recursive=True)

Import all submodules of a module, recursively, including subpackages

Parameters:
  • package (str | module) – package (name or actual module)

  • recursive – Flag if package is a submodule

Return type:

dict[str, types.ModuleType]

pysiral.set_psrl_cpu_count(cpu_count: int) None

Set the pysiral-wide CPU count for multiprocessing to the pysiral package configuration

Parameters:

cpu_count – The number of CPU’s to use

Raises:

ValueError – cpu_count is not a positive integer