pysiral
=======

.. py:module:: pysiral

.. autoapi-nested-parse::

   pysiral is the PYthon Sea Ice Radar ALtimetry toolbox



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/pysiral/_exceptions/index
   /autoapi/pysiral/_logger/index
   /autoapi/pysiral/_version/index
   /autoapi/pysiral/auxdata/index
   /autoapi/pysiral/core/index
   /autoapi/pysiral/cryosat2/index
   /autoapi/pysiral/dot/index
   /autoapi/pysiral/envisat/index
   /autoapi/pysiral/ers/index
   /autoapi/pysiral/filter/index
   /autoapi/pysiral/frb/index
   /autoapi/pysiral/grid/index
   /autoapi/pysiral/l1data/index
   /autoapi/pysiral/l1preproc/index
   /autoapi/pysiral/l2data/index
   /autoapi/pysiral/l2preproc/index
   /autoapi/pysiral/l2proc/index
   /autoapi/pysiral/l3proc/index
   /autoapi/pysiral/mask/index
   /autoapi/pysiral/retracker/index
   /autoapi/pysiral/scripts/index
   /autoapi/pysiral/sentinel3/index
   /autoapi/pysiral/sit/index
   /autoapi/pysiral/sla/index
   /autoapi/pysiral/surface/index
   /autoapi/pysiral/waveform/index


Attributes
----------

.. autoapisummary::

   pysiral.__version__
   pysiral.__git_version__
   pysiral.__git_branch__
   pysiral.__git_origin__
   pysiral.psrlcfg


Functions
---------

.. autoapisummary::

   pysiral.get_cls
   pysiral.import_submodules
   pysiral.set_psrl_cpu_count


Package Contents
----------------

.. py:data:: __version__

.. py:data:: __git_version__

.. py:data:: __git_branch__

.. py:data:: __git_origin__

.. py:data:: psrlcfg

.. py:function:: get_cls(module_name, class_name, relaxed=True)

   Small helper function to dynamically load classes


.. py:function:: import_submodules(package, recursive=True)

   Import all submodules of a module, recursively, including subpackages

   :param package: package (name or actual module)
   :param recursive: Flag if package is a submodule
   :type package: str | module
   :rtype: dict[str, types.ModuleType]


.. py:function:: set_psrl_cpu_count(cpu_count: int) -> None

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

   :param cpu_count: The number of CPU's to use

   :raises ValueError: cpu_count is not a positive integer