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

Document how to plot only one variable without any additional data available #1639

Closed
soerenjoh opened this issue Dec 16, 2022 · 1 comment
Closed
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@soerenjoh
Copy link

Some suggestion to add to the documentation:
While trying to get a MSWMS server running with new model data, I tried to do a minimal example to just plot temperature on pressure levels. With the examples given in the documentation, always additional model variables (e.g. PV or Theta) were necessary. I suggest to include a very simple example of how to make a simple plot for a certain variable in the documentation. @joernu76 proposed the following approach, which worked out fine for me:

mpl_hsec_styles.make_generic_class("HS_MyStyle_pl_air_temperature",'air_temperature','pl',[],[])
register_horizontal_layers = [
    (mpl_hsec_styles.HS_MyStyle_pl_air_temperature, ["model"]),
    ]

And for vertical plots:

mpl_vsec_styles.make_generic_class("VS_MyStyle_pl_air_temperature",'air_temperature','pl',[],[])
register_vertical_layers = [
    (mpl_vsec_styles.VS_MyStyle_pl_air_temperature, ["model"]),
    ]

And for line plots simply:

register_linear_layers = [
    (mpl_lsec_styles.LS_DefaultStyle, "air_temperature","pl", ["model"]),
    ]

However, this may be too much information for https://mss.readthedocs.io/en/stable/mswms.html , which is already too long in my opinion. It might be a good idea to also restructure this page.

@ReimarBauer ReimarBauer added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 19, 2022
@ReimarBauer ReimarBauer added this to the 8.0.0 milestone Dec 19, 2022
@ReimarBauer
Copy link
Member

While we restructure the documentation we have to keep urls valid because of linked from our publication.

We maybe can describe a few minimized examples. These have to become test covered so that we learn when we need to improve them.

@ReimarBauer ReimarBauer self-assigned this Mar 2, 2023
@ReimarBauer ReimarBauer modified the milestones: 8.0.0, 7.0.8 Mar 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants