Utils API Index

Utils API Index#

This is the Utils package which forms a part of the PyEarthTools package.

The rest of this page contains reference information for the components of the Utils package. The Utils API docs can be viewed at Utils API Docs.

Module

Purpose

API Docs

utils

- dynamic_import

- load

- save

utils.config

- canonical_name

- merge

- collect_yaml

- collect_env

- ensure_file

- collect

- refresh

- get

- pop

- update_defaults

- expand_environment_variables

- rename

- check_deprecations

- set

utils.context

- ChangeValue

- Catch

- PrintOnError

utils.data

- Tesselator

- converter.xarrayConverter

- converter.NumpyConverter

- converter.DaskConverter

utils.decorators

Define parameters which are aliases (e.g ‘t2m’ and ‘2t’)

- alias_arguments

Reverse a 1:1 dictionary mapping

- invert_dictionary_list

- classproperty

utils.initialisation

- dynamic_import

- load

- save

- update_contents

- InitialisationRecordingMixin

- Dumper

- Loader

utils.logger

- initiate_logging

- reconfigure

utils.parameter

- SingleParameter

- ListParameter

- RangeParameter

- search

- search_threaded

utils.repr_utils

- provide_html

- html

- default