data.readers.csv

Classes

CSVReader

Class representing CSV data

Module Contents

class data.readers.csv.CSVReader(source, path, compression=None)

Bases: data.readers.Reader

Class representing CSV data

to_pandas(comment='#', pandas_read_csv_kwargs=None, **kwargs)

Convert CSV data into a pandas.DataFrame using pandas.read_csv().

Please note that Earthkit should be able to handle compressed file objects.

Parameters:

• comment (str) – Character that represents a comment line in csv file. This value is ignored if the comment character is defined in pandas_read_csv_kwargs.

• pandas_read_csv_kwargs (dict) – kwargs passed to pandas.read_csv(), this is used for safe parsing of kwargs via intermediate methods

Return type:

pandas.DataFrame

Examples

>>> import earthkit.data
>>> ds = earthkit.data.from_source("file", "data_with_comments.csv")
>>> df = ds.to_pandas(pandas_read_csv_kwargs={"comment": "#"})

to_xarray(pandas_read_csv_kwargs=None, **kwargs)

Convert CSV data into an xarray object`.

First, the data is converted into a pandas.DataFrame with pandas.read_csv(), then pandas.DataFrame.to_xarray() is called to generate the xarray object.

Parameters:

pandas_read_csv_kwargs (dict) – kwargs passed to pandas.read_csv().

Return type:

Xarray object