fluidsht

FluidSHT: Spherical Harmonics Transform API

The sht and related operators classes are in the subpackages

sht2d

2D Spherical Harmonics Transform classes (fluidsht.sht2d)

This root module provides two helper functions to import sht classes and create sht objects:

fluidsht.import_sht_class(method, raise_import_error=True)[source]

Import a sht class.

Parameters
methodstr

Name of module or string characterizing a method. It has to correspond to a module of fluidsht. The first part “fluidsht.” of the module “path” can be omitted.

raise_import_error{True}, False

If raise_import_error == False and if there is an import error, the function handles the error and returns None.

Returns
The corresponding SHT class.
fluidsht.create_sht_object(method, n0=None, n1=None, n2=None, lmax=15, *args, **kwargs)[source]

Helper for creating sht objects.

Parameters
methodstr

Name of module or string characterizing a method. It has to correspond to a module of fluidsht. The first part “fluidsht.” of the module “path” can be omitted.

n0, n1, n2int

Dimensions of the real space array (in sequential).

lmaxint

Truncation degree

Returns
The corresponding SHT object.

Functions

create_sht_object(method[, n0, n1, n2, lmax])

Helper for creating sht objects.

import_sht_class(method[, raise_import_error])

Import a sht class.