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 MiRS and mimicTPW2_comp readers to sphinx documentation #1599

Merged
merged 6 commits into from
Mar 16, 2021
Merged

Add MiRS and mimicTPW2_comp readers to sphinx documentation #1599

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d01b1e0
Merge branch 'iss1387' of github.com:joleenf/satpy
joleenf Oct 23, 2020
aa10285
Merge branch 'master' of https://github.com/pytroll/satpy
joleenf Oct 23, 2020
b2f71df
Merge with upstream development
joleenf Nov 24, 2020
c164f61
Merge remote-tracking branch 'refs/remotes/origin/master'
joleenf Mar 11, 2021
b5317fb
Add mirs and mimic readers to rstindex
joleenf Mar 15, 2021
865529d
Fix mimic reader name to match yaml
joleenf Mar 16, 2021
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
6 changes: 6 additions & 0 deletions doc/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,12 @@ the base Satpy installation.
* - AMSR2 level 2 GAASP in NetCDF4 format
- `amsr2_l2_gaasp`
- Beta
* - MiRS level 2 Precipitation and Surface Products (IMG) in NetCDF4 format
- `mirs`
- Beta
* - MIMIC Total Precipitable Water Product Reader in NetCDF format
- mimic_TPW2_nc
Copy link
Member

Choose a reason for hiding this comment

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

So it looks like the name is actually mimicTPW2_comp but the python module is mimic_TPW2_nc. We don't need to change it, but this name is ugly. I didn't think we were going to allow uppercase letters in a reader name. Well here we are I guess.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I will fix it in the index. I can change the uppercase for the reader too, it is up to you. I might be the only one using the mimic reader.

Copy link
Member

Choose a reason for hiding this comment

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

Maybe change the name in another PR. Let's see what @mraspaud and others think about on slack. What does comp mean by the way?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

comp means that I was just getting started with satpy and did not know what to call it. :) Originally, the reader name matched the name mimicTPW2_comp in the yaml file. I changed the reader name when I reread the documentation, but forgot to change it within the yaml file. FWIW, comp was meant to signal that this is a composite of tpw from the MiRS suite. Someone else mentioned that the sensor and platform names are well named at all and the word product should appear somewhere. This is the opportunity to fix many issues. sensor name, platform name, navigation description and reader name.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I can pull the mimic information from index.rst until that is resolved, but the MiRS information can remain in the index.rst for the PR.

Copy link
Member

Choose a reason for hiding this comment

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

Keep both, but just fix the name of the mimic reader in the table so it matches what the reader is actually called (in the YAML, not the python module).

- Beta

Indices and tables
==================
Expand Down