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

Add more usage examples #28

Open
tcmetzger opened this issue Apr 1, 2024 · 8 comments
Open

Add more usage examples #28

tcmetzger opened this issue Apr 1, 2024 · 8 comments
Assignees
Labels
good first issue Good for newcomers
Milestone

Comments

@tcmetzger
Copy link
Collaborator

tcmetzger commented Apr 1, 2024

To make it easier to start using this library and illustrate its various use cases, we want to add usage examples highlighting the additional cloud and aerosol- related functionalities (Jupyter notebooks in the repository’s /examples folder)

@tcmetzger tcmetzger added the good first issue Good for newcomers label Apr 1, 2024
@tcmetzger tcmetzger added this to the Future milestone Apr 9, 2024
@tcmetzger tcmetzger modified the milestones: Future, Phase 2 Oct 11, 2024
@tcmetzger
Copy link
Collaborator Author

@RobertPincus could pull one time-step from aqua planet (a round planet without elevation)

@sehnem
Copy link
Collaborator

sehnem commented Nov 15, 2024

We need to add examples that use different paths on processing the data. Currently just two functions of RTE are used, we should implement all the functions and use them.

@RobertPincus
Copy link
Member

@sehnem I can do that. Do you mean to extend the testing suite?

@sehnem
Copy link
Collaborator

sehnem commented Nov 15, 2024

@RobertPincus it would be good to have the same examples in fortran too, so we could use the same output data to test both and make sure it is consistent, it can be just examples, in python I use the examples as integration tests.

@RobertPincus
Copy link
Member

@sehnem I have such examples in tests/test_variants; I can think about how to incorporate them.

@sehnem
Copy link
Collaborator

sehnem commented Nov 15, 2024

@RobertPincus I think that this is what I need, will use this as reference and implement it in python.

@RobertPincus
Copy link
Member

@sehnem The most widely-used variant that's different from the clear sky is longwave clouds for which we use two-stream optical properties. For this we will need the cloud-optics in Python, as well as the ability to add two sets of optical properties together. The latter I can help with. The Python cloud optics is #53 and should be ready for Makepath to implement.

@RobertPincus
Copy link
Member

@sehnem In the Fortran repo examples/all-sky would be another good example. It uses idealized profiles of temperature, humidity, and ozone; adds a bunch of other gases as scalars, and adds cloud to 2/3 of the columns. The clouds employ the 2-stream/LW logic. There are reference answers in the data repo.

The all-sky example might also be useful because it's very flexible - users can pick the number of columns and the vertical discretization, and we sometimes use it to assess timing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
Status: In progress
Development

No branches or pull requests

3 participants