Skip to content

Latest commit

 

History

History
128 lines (95 loc) · 2.64 KB

dataset.rst

File metadata and controls

128 lines (95 loc) · 2.64 KB

Dataset overview

.. currentmodule:: pygeode

Essentially, a Dataset is a collection of variables which are related to each other in some way. For example, when you load a file into PyGeode, a single Dataset is created, containing all variables from that file.

Here's an example of a Dataset, with a single variable:

>>> from pygeode.tutorial import t1
>>> print(t1)
<Dataset>:
Vars:
  Temp (lat,lon)  (31,60)
Axes:
  lat <Lat>      :  90 S to 90 N (31 values)
  lon <Lon>      :  0 E to 354 E (60 values)
Global Attributes:
  history        : Synthetic Temperature data generated by pygeode

This particular Dataset has a single variable inside (named Temp), defined over latitude and longitude. We can reference a particular :class:`Var` object using a dot (.), treating it as a member of the Dataset:

>>> x = t1.Temp
>>> print(x)
<Var 'Temp'>:
  Units: K  Shape:  (lat,lon)  (31,60)
  Axes:
    lat <Lat>      :  90 S to 90 N (31 values)
    lon <Lon>      :  0 E to 354 E (60 values)
  Attributes:
    {}
  Type:  Add_Var (dtype="float64")

More examples can be found in tut_datasets.

Attributes

.. autosummary::

  Dataset.vars
  Dataset.vardict
  Dataset.axes
  Dataset.atts

Methods

.. autosummary::

  Dataset.__init__
  Dataset.__getitem__
  Dataset.__call__
  Dataset.add
  Dataset.copy
  Dataset.load
  Dataset.map
  Dataset.remove
  Dataset.rename_vars
  Dataset.replace_vars

Variable operations

.. autosummary::

  Dataset.smooth
  Dataset.deriv
  Dataset.diff
  Dataset.integrate
  Dataset.composite
  Dataset.flatten
  Dataset.fft_smooth
  Dataset.lag
  Dataset.interpolate
  Dataset.squeeze
  Dataset.extend
  Dataset.transpose
  Dataset.sorted
  Dataset.replace_axes
  Dataset.rename
  Dataset.rename_axes
  Dataset.fill
  Dataset.unfill
  Dataset.as_type

Dataset Attributes

.. autoattribute:: Dataset.vars
  :annotation: list of Var instances


.. autoattribute:: Dataset.vardict
  :annotation: dictionary of Var instances


.. autoattribute:: Dataset.axes
  :annotation: list of Axis instances


.. autoattribute:: Dataset.atts
  :annotation: dictionary

Dataset Methods

.. automethod:: Dataset.__init__


.. automethod:: Dataset.__getitem__


.. automethod:: Dataset.__call__


.. automethod:: Dataset.add


.. automethod:: Dataset.copy


.. automethod:: Dataset.load


.. automethod:: Dataset.map


.. automethod:: Dataset.remove


.. automethod:: Dataset.rename_vars


.. automethod:: Dataset.replace_vars