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

Update docs: Fix links, Add aircraft plots, Update yaml descriptions, Update observation description #342

Open
wants to merge 11 commits into
base: develop
Choose a base branch
from

Conversation

rschwant
Copy link
Collaborator

@rschwant rschwant commented Mar 7, 2025

This updates the docs and will close the following issues:

  • Update old project board links on ReadTheDocs
    #224
  • Update documentation for all observational and model datasets
    #205
  • Update YAML options in Scatter Density plot
    #293
  • Need to update aircraft plot descriptions on ReadTheDocs
    #294
  • Need to add aircraft plot yaml descriptions to the yaml appendix
    #295
  • I also updated the aircraft examples, to make the plots look nicer, so only 2 day pairing and bigger font sizes.

During this process, I realized that some of the YAML options in the aircraft plots are not fully connected but still listed in the example YAML files and or need some cleaning up. I created a new issue for this that we will address in Version 2. All YAML options described on the ReadTheDocs YAML appendix description seem to be working as specified and represent the base options available so far for these plots. Clean up aircraft plotting example YAML files #341.

@rschwant rschwant requested review from quaz115 and zmoon March 7, 2025 18:51
@rschwant
Copy link
Collaborator Author

I just added a note for the CONUS extent to this PR too. This will close this PR too: domain_type == 'all' behavior
#140

I also created a new issue and put it in version 2 to generalize this extent feature: #343. Generalizing this now since it is used in several examples seems to rushed. Better to document current capabilities and we can advance this further in version 2.

Copy link
Collaborator

@zmoon zmoon left a comment

Choose a reason for hiding this comment

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

A few initial comments

@rschwant
Copy link
Collaborator Author

This is ready for review when you all have time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants