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.

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

doc: move reader table to reading section #2812

Merged
merged 7 commits into from
Jun 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ The following people have made contributions to this project:
- [Lars Ørum Rasmussen (loerum)](https://github.com/loerum)
- [Martin Raspaud (mraspaud)](https://github.com/mraspaud)
- [William Roberts (wroberts4)](https://github.com/wroberts4)
- [Benjamin Rösner (BENR0)](https://github.com/BENR0)
- [Pascale Roquet (roquetp)](https://github.com/roquetp)
- [Kristian Rune Larsen](https://github.com/)
- [RutgerK (RutgerK)](https://github.com/RutgerK)
Expand Down
6 changes: 4 additions & 2 deletions doc/source/_static/main.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
$(document).ready( function () {
$('table.datatable').DataTable( {
"paging": false,
"paging": true,
"pageLength": 15,
"layout": {
'topStart': 'info',
'topEnd': 'search',
'bottomStart': null
'bottomStart': null,
'bottomEnd': 'paging'
},
"order": [[0, 'asc']]
} );
Expand Down
37 changes: 7 additions & 30 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ remote-sensing earth-observing satellite instruments. Satpy
provides users with readers that convert geophysical parameters from various
file formats to the common Xarray :class:`~xarray.DataArray` and
:class:`~xarray.Dataset` classes for easier interoperability with other
scientific python libraries. Satpy also provides interfaces for creating
RGB (Red/Green/Blue) images and other composite types by combining data
from multiple instrument bands or products. Various atmospheric corrections
and visual enhancements are provided for improving the usefulness and quality
of output images. Output data can be written to
scientific python libraries. For a full list of available readers see :ref:`reader_table`.
Satpy also provides interfaces for creating RGB (Red/Green/Blue) images and other
composite types by combining data from multiple instrument bands or products.
Various atmospheric corrections and visual enhancements are provided for
improving the usefulness and quality of output images. Output data can be written to
multiple output file formats such as PNG, GeoTIFF, and CF standard NetCDF
files. Satpy also allows users to resample data to geographic projected grids
(areas). Satpy is maintained by the open source
Expand Down Expand Up @@ -80,34 +80,11 @@ Documentation
Release Notes <https://github.com/pytroll/satpy/blob/main/CHANGELOG.md>
Security Policy <https://github.com/pytroll/satpy/blob/main/SECURITY.md>

.. _reader_table:

.. 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.
Please note that the reader table that used to be placed here has moved to the "reading"
section here: :ref:`reader_table`.

Indices and tables
==================
Expand Down
202 changes: 118 additions & 84 deletions doc/source/reading.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,124 @@ To return additional reader information use `available_readers(as_dict=True)`::
>>> from satpy import available_readers
>>> available_readers()


.. _reader_table:

Reader Table
------------

.. 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.

Documentation for specific readers
----------------------------------

SEVIRI L1.5 data readers
BENR0 marked this conversation as resolved.
Show resolved Hide resolved
^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: satpy.readers.seviri_base
:noindex:

SEVIRI HRIT format reader
"""""""""""""""""""""""""

.. automodule:: satpy.readers.seviri_l1b_hrit
:noindex:

SEVIRI Native format reader
"""""""""""""""""""""""""""

.. automodule:: satpy.readers.seviri_l1b_native
:noindex:

SEVIRI netCDF format reader
"""""""""""""""""""""""""""

.. automodule:: satpy.readers.seviri_l1b_nc
:noindex:


Other xRIT-based readers
^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: satpy.readers.hrit_base
:noindex:


JMA HRIT format reader
^^^^^^^^^^^^^^^^^^^^^^


.. automodule:: satpy.readers.hrit_jma
:noindex:

GOES HRIT format reader
^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: satpy.readers.goes_imager_hrit
:noindex:

Electro-L HRIT format reader
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: satpy.readers.electrol_hrit
:noindex:

hdf-eos based readers
^^^^^^^^^^^^^^^^^^^^^

.. automodule:: satpy.readers.modis_l1b
:noindex:

.. automodule:: satpy.readers.modis_l2
:noindex:

satpy cf nc readers
^^^^^^^^^^^^^^^^^^^

.. automodule:: satpy.readers.satpy_cf_nc
:noindex:

hdf5 based readers
^^^^^^^^^^^^^^^^^^

.. automodule:: satpy.readers.agri_l1
:noindex:

.. automodule:: satpy.readers.ghi_l1
:noindex:

Arctica-M N1 HDF5 format reader
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: satpy.readers.msu_gsa_l1b
:noindex:


Filter loaded files
===================

Expand Down Expand Up @@ -290,87 +408,3 @@ Adding a Reader to Satpy
========================

This is described in the developer guide, see :doc:`dev_guide/custom_reader`.

Implemented readers
===================

SEVIRI L1.5 data readers
------------------------

.. automodule:: satpy.readers.seviri_base
:noindex:

SEVIRI HRIT format reader
^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: satpy.readers.seviri_l1b_hrit
:noindex:

SEVIRI Native format reader
^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: satpy.readers.seviri_l1b_native
:noindex:

SEVIRI netCDF format reader
^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: satpy.readers.seviri_l1b_nc
:noindex:


Other xRIT-based readers
------------------------

.. automodule:: satpy.readers.hrit_base
:noindex:


JMA HRIT format reader
^^^^^^^^^^^^^^^^^^^^^^


.. automodule:: satpy.readers.hrit_jma
:noindex:

GOES HRIT format reader
^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: satpy.readers.goes_imager_hrit
:noindex:

Electro-L HRIT format reader
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: satpy.readers.electrol_hrit
:noindex:

hdf-eos based readers
---------------------

.. automodule:: satpy.readers.modis_l1b
:noindex:

.. automodule:: satpy.readers.modis_l2
:noindex:

satpy cf nc readers
---------------------

.. automodule:: satpy.readers.satpy_cf_nc
:noindex:

hdf5 based readers
------------------

.. automodule:: satpy.readers.agri_l1
:noindex:

.. automodule:: satpy.readers.ghi_l1
:noindex:

Arctica-M N1 HDF5 format reader
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: satpy.readers.msu_gsa_l1b
:noindex:
Loading