Documentation of absorption options

[stefanbuehler]

In the course "radiation and climate" last term, a long standing problem popped up again: How to make absorption options discoverable?

With absorption options I mean all the species tags that we have, for example continuum models, CIA, halocarbons, line-by-line.

Students missed that they can calculate absorption also for many species that do not have line files.

I think there are (at least) three separate issues here:
a There should be an exhaustive list of options somewhere (perhaps there already is?)
b It should be very easy to find
c How to keep it up-to-date?

For b, perhaps an example in the examples folder would be best. It could also be a meta-example that shows how to use one or more built-in methods to generate lists of allowed tags.

Any thoughts on this?

[riclarsson]

Ok, so students are not reading the documentation.

This is automatically generated as part of the method you set it with. The list is thus complete and always up-to-date. The predefined models are also guaranteed complete because it is tested. You cannot get a green tick on the actions without documenting any new model you add.

I do not wish to engage in finding solutions for people's inability of reading and googling. We must give up on some people.

What needs to improve is the concept page. I've not had time to add text there. But yet again, it's there that we do have more than lbl

[stefanbuehler]

Wonderful, I love both the method documentation and the concept page!

I think we should just advertise it even more. Will discuss with Oliver, if we could add an example that uses different absorption models and explicitly points to both these resources in the comments.

This kind of redundancy (in the advertising, not in the functionality!) Is good, I think.