From c819c975172393c9a60660dc23ba55d25ad0ae44 Mon Sep 17 00:00:00 2001 From: BENR0 Date: Fri, 16 Feb 2024 09:44:49 +0100 Subject: [PATCH 1/7] fix table order and update to datatables v2. --- doc/source/_static/main.js | 7 ++++++- doc/source/conf.py | 4 ++-- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/doc/source/_static/main.js b/doc/source/_static/main.js index 188a335e71..b153beb2f3 100644 --- a/doc/source/_static/main.js +++ b/doc/source/_static/main.js @@ -1,6 +1,11 @@ $(document).ready( function () { $('table.datatable').DataTable( { "paging": false, - "dom": 'lfitp' + "layout": { + 'topStart': 'info', + 'topEnd': 'search', + 'bottomStart': null + }, + "order": [[0, 'asc']] } ); } ); diff --git a/doc/source/conf.py b/doc/source/conf.py index 49e47b2cc2..020544ee4a 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -194,11 +194,11 @@ def __getattr__(cls, name): html_css_files = [ "theme_overrides.css", # override wide tables in RTD theme - "https://cdn.datatables.net/1.10.23/css/jquery.dataTables.min.css", + "https://cdn.datatables.net/v/dt/dt-2.0.0/datatables.min.css", ] html_js_files = [ - "https://cdn.datatables.net/1.10.23/js/jquery.dataTables.min.js", + "https://cdn.datatables.net/v/dt/dt-2.0.0/datatables.min.js", "main.js", ] From 46556d31d70095695a045473c9e662e2da01cfe1 Mon Sep 17 00:00:00 2001 From: BENR0 Date: Fri, 16 Feb 2024 09:47:00 +0100 Subject: [PATCH 2/7] Add status description again and insert link to it in dev guide. --- doc/source/dev_guide/custom_reader.rst | 3 ++- doc/source/index.rst | 24 ++++++++++++++++++++++++ 2 files changed, 26 insertions(+), 1 deletion(-) diff --git a/doc/source/dev_guide/custom_reader.rst b/doc/source/dev_guide/custom_reader.rst index a77988760e..a5656795ca 100644 --- a/doc/source/dev_guide/custom_reader.rst +++ b/doc/source/dev_guide/custom_reader.rst @@ -117,7 +117,8 @@ The parameters to provide in this section are: file format. This can be multiline if formatted properly in YAML (see example below). status - The status of the reader (one of: Nominal, Beta, Alpha) + The status of the reader (one of: Nominal, Beta, Alpha, Defunct; see :ref:`Status Description ` + for more details). supports_fsspec If the reader supports reading data via fsspec (either true or false). sensors diff --git a/doc/source/index.rst b/doc/source/index.rst index 052a7e2d03..b229c904ee 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -84,6 +84,30 @@ Documentation .. include:: reader_table.rst +.. _Status Description: +.. note:: + + Status description: + + Defunct + Most likely the reader is not functional. If it is there is a good chance of + bugs and/or performance problems (e.g. not ported to dask/xarray yet). Future + development is unclear. Users are encouraged to contribute (see section + :doc:`dev_guide/CONTRIBUTING` and/or get help on Slack or by opening a Github issue). + + 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. + + Beta + This denotes final developement status. Reader is functional and implements all + nominal features. Results should be dependable but there might be bugs. Users + are actively encouraged to test and report bugs. + + Nominal + This denotes a finished status. Reader is functional and most likely no new + features will be introduced. It has been tested and there are no known bugs. Indices and tables ================== From b280236ba1fd70c8f9763e3d33e23d51f298b2c2 Mon Sep 17 00:00:00 2001 From: BENR0 Date: Fri, 16 Feb 2024 09:47:44 +0100 Subject: [PATCH 3/7] fix missing info in multiple readers. --- satpy/etc/readers/agri_fy4a_l1.yaml | 2 +- satpy/etc/readers/agri_fy4b_l1.yaml | 4 ++++ satpy/etc/readers/ghi_l1.yaml | 4 ++++ satpy/etc/readers/meris_nc_sen3.yaml | 6 +++++- satpy/etc/readers/mersi_ll_l1b.yaml | 6 +++++- satpy/etc/readers/sgli_l1b.yaml | 6 +++++- satpy/etc/readers/viirs_edr.yaml | 6 +++++- 7 files changed, 29 insertions(+), 5 deletions(-) diff --git a/satpy/etc/readers/agri_fy4a_l1.yaml b/satpy/etc/readers/agri_fy4a_l1.yaml index 5e3dfead35..cd7c7a8fe0 100644 --- a/satpy/etc/readers/agri_fy4a_l1.yaml +++ b/satpy/etc/readers/agri_fy4a_l1.yaml @@ -5,7 +5,7 @@ reader: name: agri_fy4a_l1 short_name: AGRI FY4A L1 - long_name: FY-4A AGRI L1 data in HDF5 format + long_name: FY-4A AGRI Level 1 HDF5 format description: FY-4A AGRI instrument HDF5 reader status: Beta supports_fsspec: false diff --git a/satpy/etc/readers/agri_fy4b_l1.yaml b/satpy/etc/readers/agri_fy4b_l1.yaml index b1ff44189d..2b47e51cdb 100644 --- a/satpy/etc/readers/agri_fy4b_l1.yaml +++ b/satpy/etc/readers/agri_fy4b_l1.yaml @@ -4,7 +4,11 @@ reader: name: agri_fy4b_l1 + short_name: AGRI FY4B L1 + long_name: FY-4B AGRI Level 1 data HDF5 format description: FY-4B AGRI instrument HDF5 reader + status: Beta + supports_fsspec: false sensors: [agri] default_channels: reader: !!python/name:satpy.readers.yaml_reader.FileYAMLReader diff --git a/satpy/etc/readers/ghi_l1.yaml b/satpy/etc/readers/ghi_l1.yaml index 59c8f35f70..0c2e595253 100644 --- a/satpy/etc/readers/ghi_l1.yaml +++ b/satpy/etc/readers/ghi_l1.yaml @@ -4,7 +4,11 @@ reader: name: ghi_l1 + short_name: GHI FY4A L1 + long_name: FY-4A GHI Level 1 HDF5 format description: FY-4A GHI instrument HDF5 reader + status: Beta + supports_fsspec: false sensors: [ghi] default_channels: reader: !!python/name:satpy.readers.yaml_reader.FileYAMLReader diff --git a/satpy/etc/readers/meris_nc_sen3.yaml b/satpy/etc/readers/meris_nc_sen3.yaml index ba3d02969a..28d5597665 100644 --- a/satpy/etc/readers/meris_nc_sen3.yaml +++ b/satpy/etc/readers/meris_nc_sen3.yaml @@ -1,6 +1,10 @@ reader: - description: NC Reader for MERIS data (Sentinel 3 like format) name: meris_nc_sen3 + short_name: MERIS Sentinel 3 + long_name: Sentinel 3 MERIS NetCDF format + description: NC Reader for MERIS data (Sentinel 3 like format) + status: Beta + supports_fsspec: false sensors: [meris] default_channels: [] reader: !!python/name:satpy.readers.yaml_reader.FileYAMLReader diff --git a/satpy/etc/readers/mersi_ll_l1b.yaml b/satpy/etc/readers/mersi_ll_l1b.yaml index 7c572885c7..6ea44dcb99 100644 --- a/satpy/etc/readers/mersi_ll_l1b.yaml +++ b/satpy/etc/readers/mersi_ll_l1b.yaml @@ -1,6 +1,10 @@ reader: - description: FY-3E Medium Resolution Spectral Imager - Low Light (MERSI-LL) L1B Reader name: mersi_ll_l1b + short_name: MERSI Low Light FY3E L1B + long_name: FY-3E MERSI Low Light Level 1B + description: FY-3E Medium Resolution Spectral Imager - Low Light (MERSI-LL) L1B Reader + status: Beta + supports_fsspec: false sensors: [mersi-ll] reader: !!python/name:satpy.readers.yaml_reader.FileYAMLReader diff --git a/satpy/etc/readers/sgli_l1b.yaml b/satpy/etc/readers/sgli_l1b.yaml index 9f8108510f..4cb86890c4 100644 --- a/satpy/etc/readers/sgli_l1b.yaml +++ b/satpy/etc/readers/sgli_l1b.yaml @@ -1,7 +1,11 @@ reader: + name: sgli_l1b + short_name: SGLI GCOM-C L1B + long_name: GCOM-C SGLI Level 1B HDF5 format description: Reader for SGLI data + status: Beta + supports_fsspec: false reference: https://gportal.jaxa.jp/gpr/assets/mng_upload/GCOM-C/SGLI_Level1_Product_Format_Description_en.pdf - name: sgli_l1b sensors: [sgli] default_channels: [] reader: !!python/name:satpy.readers.yaml_reader.FileYAMLReader diff --git a/satpy/etc/readers/viirs_edr.yaml b/satpy/etc/readers/viirs_edr.yaml index 37f36934b8..2228b25916 100644 --- a/satpy/etc/readers/viirs_edr.yaml +++ b/satpy/etc/readers/viirs_edr.yaml @@ -1,6 +1,10 @@ reader: - description: VIIRS NOAA Enterprise EDR product reader name: viirs_edr + short_name: VIIRS JPSS EDR nc + long_name: JPSS VIIRS EDR NetCDF format + description: VIIRS NOAA Enterprise EDR product reader + status: Beta + supports_fsspec: false reader: !!python/name:satpy.readers.yaml_reader.FileYAMLReader sensors: [viirs] group_keys: ['platform_shortname'] From a08797142e4d9b1ef45e6db8dae8b9486ed7194b Mon Sep 17 00:00:00 2001 From: BENR0 Date: Fri, 16 Feb 2024 10:24:26 +0100 Subject: [PATCH 4/7] refactor viirs platform name. --- satpy/etc/readers/viirs_compact.yaml | 2 +- satpy/etc/readers/viirs_l1b.yaml | 2 +- satpy/etc/readers/viirs_sdr.yaml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/satpy/etc/readers/viirs_compact.yaml b/satpy/etc/readers/viirs_compact.yaml index 31f4201930..5dca3abbaa 100644 --- a/satpy/etc/readers/viirs_compact.yaml +++ b/satpy/etc/readers/viirs_compact.yaml @@ -1,7 +1,7 @@ reader: name: viirs_compact short_name: VIIRS Compact - long_name: SNPP VIIRS SDR data in HDF5 Compact format + long_name: JPSS VIIRS SDR data in HDF5 Compact format description: Generic Eumetsat Compact VIIRS Reader status: Nominal supports_fsspec: false diff --git a/satpy/etc/readers/viirs_l1b.yaml b/satpy/etc/readers/viirs_l1b.yaml index f078c4247d..4622f7e415 100644 --- a/satpy/etc/readers/viirs_l1b.yaml +++ b/satpy/etc/readers/viirs_l1b.yaml @@ -1,7 +1,7 @@ reader: name: viirs_l1b short_name: VIIRS l1b - long_name: SNPP VIIRS Level 1b data in netCDF4 format + long_name: JPSS VIIRS Level 1b data in netCDF4 format description: Generic NASA VIIRS L1B Reader status: Nominal supports_fsspec: false diff --git a/satpy/etc/readers/viirs_sdr.yaml b/satpy/etc/readers/viirs_sdr.yaml index e85c7f4f70..70f2c5f34a 100644 --- a/satpy/etc/readers/viirs_sdr.yaml +++ b/satpy/etc/readers/viirs_sdr.yaml @@ -1,7 +1,7 @@ reader: name: viirs_sdr short_name: VIIRS SDR - long_name: SNPP VIIRS data in HDF5 SDR format + long_name: JPSS VIIRS data in HDF5 SDR format description: VIIRS SDR Reader status: Nominal supports_fsspec: false From 40633bd3ed906b3b669f7c0ab8a621458477125a Mon Sep 17 00:00:00 2001 From: David Hoese Date: Fri, 16 Feb 2024 10:09:40 -0600 Subject: [PATCH 5/7] Update short_name in satpy/etc/readers/viirs_edr.yaml --- satpy/etc/readers/viirs_edr.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/satpy/etc/readers/viirs_edr.yaml b/satpy/etc/readers/viirs_edr.yaml index 2228b25916..4c4c91a91f 100644 --- a/satpy/etc/readers/viirs_edr.yaml +++ b/satpy/etc/readers/viirs_edr.yaml @@ -1,6 +1,6 @@ reader: name: viirs_edr - short_name: VIIRS JPSS EDR nc + short_name: VIIRS EDR long_name: JPSS VIIRS EDR NetCDF format description: VIIRS NOAA Enterprise EDR product reader status: Beta From f16e85a846db61bd309c7797332483e3a1130efc Mon Sep 17 00:00:00 2001 From: BENR0 Date: Mon, 19 Feb 2024 09:51:41 +0100 Subject: [PATCH 6/7] refactor: set simonpr84's readers to nominal status. --- satpy/etc/readers/agri_fy4b_l1.yaml | 2 +- satpy/etc/readers/ghi_l1.yaml | 2 +- satpy/etc/readers/mersi_ll_l1b.yaml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/satpy/etc/readers/agri_fy4b_l1.yaml b/satpy/etc/readers/agri_fy4b_l1.yaml index 2b47e51cdb..4917d08145 100644 --- a/satpy/etc/readers/agri_fy4b_l1.yaml +++ b/satpy/etc/readers/agri_fy4b_l1.yaml @@ -7,7 +7,7 @@ reader: short_name: AGRI FY4B L1 long_name: FY-4B AGRI Level 1 data HDF5 format description: FY-4B AGRI instrument HDF5 reader - status: Beta + status: Nominal supports_fsspec: false sensors: [agri] default_channels: diff --git a/satpy/etc/readers/ghi_l1.yaml b/satpy/etc/readers/ghi_l1.yaml index 0c2e595253..08c438127b 100644 --- a/satpy/etc/readers/ghi_l1.yaml +++ b/satpy/etc/readers/ghi_l1.yaml @@ -7,7 +7,7 @@ reader: short_name: GHI FY4A L1 long_name: FY-4A GHI Level 1 HDF5 format description: FY-4A GHI instrument HDF5 reader - status: Beta + status: Nominal supports_fsspec: false sensors: [ghi] default_channels: diff --git a/satpy/etc/readers/mersi_ll_l1b.yaml b/satpy/etc/readers/mersi_ll_l1b.yaml index 6ea44dcb99..6e729f07d1 100644 --- a/satpy/etc/readers/mersi_ll_l1b.yaml +++ b/satpy/etc/readers/mersi_ll_l1b.yaml @@ -3,7 +3,7 @@ reader: short_name: MERSI Low Light FY3E L1B long_name: FY-3E MERSI Low Light Level 1B description: FY-3E Medium Resolution Spectral Imager - Low Light (MERSI-LL) L1B Reader - status: Beta + status: Nominal supports_fsspec: false sensors: [mersi-ll] reader: !!python/name:satpy.readers.yaml_reader.FileYAMLReader From 8101eac924cf72506d012129958c2e877e2e26a4 Mon Sep 17 00:00:00 2001 From: BENR0 Date: Mon, 19 Feb 2024 09:56:09 +0100 Subject: [PATCH 7/7] refactor: change fsspec status for readers using hdf5_utils. --- satpy/etc/readers/agri_fy4b_l1.yaml | 2 +- satpy/etc/readers/mersi_ll_l1b.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/satpy/etc/readers/agri_fy4b_l1.yaml b/satpy/etc/readers/agri_fy4b_l1.yaml index 4917d08145..77c616b2e4 100644 --- a/satpy/etc/readers/agri_fy4b_l1.yaml +++ b/satpy/etc/readers/agri_fy4b_l1.yaml @@ -8,7 +8,7 @@ reader: long_name: FY-4B AGRI Level 1 data HDF5 format description: FY-4B AGRI instrument HDF5 reader status: Nominal - supports_fsspec: false + supports_fsspec: true sensors: [agri] default_channels: reader: !!python/name:satpy.readers.yaml_reader.FileYAMLReader diff --git a/satpy/etc/readers/mersi_ll_l1b.yaml b/satpy/etc/readers/mersi_ll_l1b.yaml index 6e729f07d1..652708d733 100644 --- a/satpy/etc/readers/mersi_ll_l1b.yaml +++ b/satpy/etc/readers/mersi_ll_l1b.yaml @@ -4,7 +4,7 @@ reader: long_name: FY-3E MERSI Low Light Level 1B description: FY-3E Medium Resolution Spectral Imager - Low Light (MERSI-LL) L1B Reader status: Nominal - supports_fsspec: false + supports_fsspec: true sensors: [mersi-ll] reader: !!python/name:satpy.readers.yaml_reader.FileYAMLReader