From 76c1c67c4c9190b9bbd236e1e699ad320b94afb3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20R=C3=B6sner?= Date: Thu, 5 Dec 2024 11:11:47 +0100 Subject: [PATCH] add platform name --- doc/source/dev_guide/custom_reader.rst | 4 +++- doc/source/reading.rst | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/source/dev_guide/custom_reader.rst b/doc/source/dev_guide/custom_reader.rst index a5656795ca..d508b276ef 100644 --- a/doc/source/dev_guide/custom_reader.rst +++ b/doc/source/dev_guide/custom_reader.rst @@ -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 ` 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/. 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`` diff --git a/doc/source/reading.rst b/doc/source/reading.rst index 2f274e9b3f..98606e707b 100644 --- a/doc/source/reading.rst +++ b/doc/source/reading.rst @@ -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