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

teca_cf_restripe is not in RTD #592

Closed
taobrienlbl opened this issue Mar 31, 2021 · 3 comments · Fixed by #596
Closed

teca_cf_restripe is not in RTD #592

taobrienlbl opened this issue Mar 31, 2021 · 3 comments · Fixed by #596
Assignees
Labels
2_medium_priority an issue that should be fixed, but is not critical to the next release

Comments

@taobrienlbl
Copy link
Collaborator

The teca_cf_restripe app (TECA/apps/teca_cf_restripe.cpp) is now part of the TECA app suite, but it is not yet documented in read-the-docs. It should appear in the table of TECA apps, and it should have a dedicated section (like https://teca.readthedocs.io/en/latest/applications.html#teca-bayesian-ar-detect).

It would be good to verify that there are no other yet-un-documented apps when doing this.

@burlen - if you think we should keep this app out of the docs for now, please let us know, and we'll hold off on this issue.

@taobrienlbl taobrienlbl added the 2_medium_priority an issue that should be fixed, but is not critical to the next release label Mar 31, 2021
@burlen
Copy link
Collaborator

burlen commented Mar 31, 2021

I agree it should be in there. It was left out intentionally of the 4.0 release as not yet ready for prime time. Recently it gained arbitrary regridding capability which is needed to apply the GFDL tc tracker on HighResMIP.

I am also in the process of adding file grouping options (--yearly, --seasonal, --monthly, --daily) based on the calendaring features developed in the temporal reduction . We'll no longer will have an excuse to keep datasets with 7300 files in them.

I plan to share this app with the group when the GFDL HighResMIP example and the file grouping feature is finished. I had planned on adding the documentation before sharing with the group.

It might make sense to hold off until the GFDL HighResMIP example is tested, and the new file grouping options are added. What do you think?

@taobrienlbl
Copy link
Collaborator Author

A potential benefit of getting the documentation in before that could be that it allows you to focus on documenting the new features and the new example, whereas @elbashandy could focus on getting up on RTD and documenting the existing command line options. This would also make the restripe app visible sooner, which could be good since it has some useful features.

I don't have strong feelings either way though.

@burlen
Copy link
Collaborator

burlen commented Mar 31, 2021

I don't have strong feeling either way, just wanted you guys to know that this one is a moving target and would likely need to have an major overhaul in the near term anyway.

@burlen burlen assigned burlen and unassigned elbashandy Apr 28, 2021
@burlen burlen linked a pull request Apr 28, 2021 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2_medium_priority an issue that should be fixed, but is not critical to the next release
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants