Update ClimaLand README

[AlexisRenchon]

Purpose

This PR modernizes the README of the root of this repo.

Have a look at how it renders here

TO DO:

(go ahead and edit this post to add to do list)

[braghiere]

Couple of comments: I would change this:

"Certain features, including global runs, are not currently available on Windows due to limitations with our regridding software."

to

"Certain features are not currently available on Windows."

Also, there two new papers to be added on the list:

Braghiere, R. K., Wang, Y., Gagné-Landmann, A., Brodrick, P. G., Bloom, A. A., Norton, A. J., Ma, S., Levine, P., Longo, M., Deck, K., Gentine, P., Worden, J. R., Frankenberg, C., & Schneider, T. (2023). The Importance of Hyperspectral Soil Albedo Information for Improving Earth System Model Projections. AGU Advances, 4(4), e2023AV000910. https://doi.org/10.1029/2023AV000910

Wang, Y., Braghiere, R. K., Yin, Y., Yao, Y., Hao, D., & Frankenberg, C. (2024). Beyond the visible: Accounting for ultraviolet and far-red radiation in vegetation productivity and surface energy budgets. Global Change Biology, 30(5), e17346. https://doi.org/10.1111/GCB.17346

[Sbozzolo]

Couple of comments: I would change this:

"Certain features, including global runs, are not currently available on Windows due to limitations with our regridding software."

to

"Certain features are not currently available on Windows."

Actually, now everything is available on windows because we don't use tempestremap anymore

[juliasloan25]

It seems pretty technical to include all of our abstract model types under "Models", e.g. AbstractImExModel and AbstractModel. Maybe we could reword this section to explain each of the model types in words instead of explaining the type hierarchy

[kmdeck]

what do you mean by multiple levels?

[AlexisRenchon]

You're right this isn't clear... I meant for example ClimaLand and ClimaLandSimulations API, where you need to go in details or not to run a simulation, for example. (I think ClimaLandSimulations is "higher level" because it does a lot of abstraction? Is this correct language to say this? I am not sure)

Should I just say "ClimaLand provides APIs and UIs?"

[kmdeck]

hmm you could say we provide APIs for model developers, as well as a higher-level user interface for running simulations?

[AlexisRenchon]

@Sbozzolo
Did you want to fix the logo or make any other change to the README?

ALL:
What do you think of the table links, docs build, documentation, CI, code coverage, downloads: do we need all of them, do we want to modify something (eventually docs from dev to stable?), do we want to add something (maybe CliMA website?)

[kmdeck]

@Sbozzolo Did you want to fix the logo or make any other change to the README?

ALL: What do you think of the table links, docs build, documentation, CI, code coverage, downloads: do we need all of them, do we want to modify something (eventually docs from dev to stable?), do we want to add something (maybe CliMA website?)

I think the only change I would make is to remove the docs build, it's not very interesting even to us I think :) I think CI and code coverage are important to have.

I think this PR is ready to go and we can add in the docs dev -> stable change when that is available?

[kmdeck]

just one small comment here - RichardsModel currently only runs in standalone. not sure if we would want it ever in a land model since it doesnt have temperature and phase change in soil?

[AlexisRenchon]

no you're right, we don't need it in land model. I'll update to "runnable only in standalone mode"

[AlexisRenchon]

I am merging this, @Sbozzolo just make a new PR if you want to modify or add anything to the README?