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

Add notes about platform name and sensor to dev guide #3008

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add notes about platform name and sensor to dev guide #3008

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion doc/source/dev_guide/custom_reader.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -485,7 +485,9 @@ needs to implement a few methods:

This method has to return an xarray.DataArray instance if the loading is
successful, containing the data and :ref:`metadata <dataset_metadata>` of the
loaded dataset, or return None if the loading was unsuccessful.
loaded dataset, or return None if the loading was unsuccessful. If the reader
is reading satellite data the returned xarray.DataArrays should also have the
attributes ``platform_name`` and ``sensor`` with names according to https://space.oscar.wmo.int/.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure this is true. Sure we try to match OSCAR but they've also changed names in their system in the past. Also we typically have sensor being lowercase and it can be a single string or a set object. I think we've also had some special cases but don't recall which ones off the top of my head.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For platform name I think that is pretty much ok, but for sensors we've used lowercase and have also replaced / with -. As an example AVHRR/3 is avhrr-3.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While I personally would like it to be like this, I did this PR to get this discussion started.

@pnuu replacing the / with - is good which is what space oscar uses. And uppercase/lowercase does not matter as well - or _. So at least for the URL it does not matter if you have AVHRR-3, avhrr-3, AVHRR_3 or avhrr_3


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``
Expand Down
2 changes: 1 addition & 1 deletion doc/source/reading.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Reader Table
Alpha
This denotes early development status. Reader is functional and implements some
or all of the nominal features. There might be bugs. Exactness of results is
not be guaranteed. Use at your own risk.
not guaranteed. Use at your own risk.

Beta
This denotes final developement status. Reader is functional and implements all
Expand Down
Loading