Skip to content

Commit

Permalink
Add documentation about y and x dimensions for custom readers
Browse files Browse the repository at this point in the history
  • Loading branch information
djhoese committed Jan 6, 2020
1 parent be0dd61 commit 737aba8
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions doc/source/dev_guide/custom_reader.rst
Original file line number Diff line number Diff line change
Expand Up @@ -466,6 +466,14 @@ needs to implement a few methods:
successful, containing the data and :ref:`metadata <dataset_metadata>` of the
loaded dataset, or return None if the loading was unsuccessful.

The DataArray should at least have a ``y`` dimension. If it is 2 or more
dimensions then it should also have an ``x`` dimension. This applies to
non-gridded data like that of a polar-orbiting satellite instrument. The
latitude dimension is typically named ``y`` and longitude named ``x``.
This may require renaming dimensions from the file, see for the
:meth:`xarray.DataArray.rename` method for more information and its use
in the example below.

- the ``get_area_def`` method, that takes as single argument the
:class:`~satpy.dataset.DatasetID` for which we want
the area. It should return a :class:`~pyresample.geometry.AreaDefinition`
Expand Down

0 comments on commit 737aba8

Please sign in to comment.