Calipso

pansat.products.satellite.calipso

This module defines the Calipso product class, which represents all supported Calipso products.

class pansat.products.satellite.calipso.CalipsoProduct(name, description)

The Calipso class defines a generic interface for Calipso products.

name

The name of the product

Type

str

description

List of variable names provided by this product.

Type

list

__init__(name, description)

Initialize self. See help(type(self)) for accurate signature.

__str__()

The full product name.

_get_provider()

Find a provider that provides the product.

property default_destination

The default destination for Calipso product is Calipso/<product_name>>

download(start_time, end_time, destination=None, provider=None)

Download data product for given time range.

Parameters

• start_time (datetime) – datetime object defining the start date of the time range.

• end_time (datetime) – datetime object defining the end date of the of the time range.

• destination (str or pathlib.Path) – The destination where to store the output data.

filename_to_date(filename)

Extract timestamp from filename.

Parameters

filename (str) – Filename of a Calipso product.

Returns

datetime object representing the timestamp of the filename.

matches(filename)

Determines whether a given filename matches the pattern used for the product.

Parameters

filename (str) – The filename

Returns

True if the filename matches the product, False otherwise.

open(filename)

Open file as xarray dataset.

Parameters

filename (pathlib.Path or str) – The Calipso file to open.

exception pansat.products.satellite.calipso.NoAvailableProviderError

Exception indicating that no suitable provider could be found for a product.

__weakref__

list of weak references to the object (if defined)