data.readers.csv
================

.. py:module:: data.readers.csv


Classes
-------

.. autoapisummary::

   data.readers.csv.CSVReader


Module Contents
---------------

.. py:class:: CSVReader(source, path, compression=None)

   Bases: :py:obj:`data.readers.Reader`


   Class representing CSV data


   .. py:method:: to_pandas(comment='#', pandas_read_csv_kwargs=None, **kwargs)

      Convert CSV data into a :py:class:`pandas.DataFrame` using :py:func:`pandas.read_csv`.

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

      :param comment: Character that represents a comment line in csv file. This value is ignored if the comment
                      character is defined in pandas_read_csv_kwargs.
      :type comment: :class:`str`
      :param pandas_read_csv_kwargs: kwargs passed to :func:`pandas.read_csv`, this is used for safe parsing of kwargs via intermediate
                                     methods
      :type pandas_read_csv_kwargs: :class:`dict`

      :rtype: :py:class:`pandas.DataFrame`

      .. rubric:: Examples

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



   .. py:method:: to_xarray(pandas_read_csv_kwargs=None, **kwargs)

      Convert CSV data into an xarray object`.

      First, the data is converted into a :py:class:`pandas.DataFrame` with :py:func:`pandas.read_csv`,
      then :py:meth:`pandas.DataFrame.to_xarray` is called to generate the xarray object.

      :param pandas_read_csv_kwargs: kwargs passed to :py:func:`pandas.read_csv`.
      :type pandas_read_csv_kwargs: :class:`dict`

      :rtype: :class:`Xarray object`