Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add documentation about y and x dimensions for custom readers #1032

Merged
merged 2 commits into from
Jan 10, 2020
Merged

Add documentation about y and x dimensions for custom readers #1032

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
420f056
Add documentation about y and x dimensions for custom readers
djhoese Jan 6, 2020
c522656
Clean up description of y/x dimensions in custom reader docs
djhoese Jan 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 9 additions & 0 deletions doc/source/dev_guide/custom_reader.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -466,6 +466,15 @@ 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. For data covering
a 2D region on the Earth, their should be at least a ``y`` and ``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