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

ClimaLand documentation to do list #745

Open
1 of 10 tasks
AlexisRenchon opened this issue Aug 30, 2024 · 2 comments
Open
1 of 10 tasks

ClimaLand documentation to do list #745

AlexisRenchon opened this issue Aug 30, 2024 · 2 comments

Comments

@AlexisRenchon
Copy link
Member

AlexisRenchon commented Aug 30, 2024

  • Make a decent "home page" and "getting started" page Alexis docs hackathon #1 Aug 23 #736
  • Home page / index page: make a summary of features
  • Getting started: [add ideas]
  • Refactor structure: e.g., API should be last, tutorials maybe second... [suggestions are welcome]
  • Getting started: explain that ClimaLand is an API to build a model (standalone or integrated), if you want an API to run a simulation, go to ClimaLandSimulations.
  • Getting started: explain "low level" vs. "high level" API, for instance, ClimaLand is low level relative to ClimaLandSimulations
  • Getting started: explain what is an "API"
  • Introduction to standalone model: explain what we call a model, and how we build it in ClimaLand, why we use Abstract type and what is multiple dispatch, demonstrate with a super simple example (MWE, maybe simple T arrhenius of soil C...), maybe do a simple model without any prognostic variable, then one with a prognostic variable, then show integrated model by combining both

See also previous issues:

Useful tutorials

  • Perform and analyze a regional simulation
  • Calibration, single sites and global
@AlexisRenchon AlexisRenchon pinned this issue Aug 30, 2024
@AlexisRenchon AlexisRenchon mentioned this issue Aug 30, 2024
36 tasks
@AlexisRenchon
Copy link
Member Author

Quick note: now that we fixed stable docs, we should refer to it in the readme

@AlexisRenchon
Copy link
Member Author

It seems one of our docs dependencies is deprecated:

┌ Formatting
│  ┌ Warning: DEPRECATION NOTICE
│  │ 
│  │ Formatting.jl has been unmaintained for a while, with some serious
│  │ correctness bugs compromising the original purpose of the package. As a result,
│  │ it has been deprecated - consider using an alternative, such as
│  │ `Format.jl` (https://github.com/JuliaString/Format.jl) or the `Printf` stdlib di
rectly.
│  │ 
│  │ If you are not using Formatting.jl as a direct dependency, please consider
│  │ opening an issue on any packages you are using that do use it as a dependency.
│  │ From Julia 1.9 onwards, you can query `]why Formatting` to figure out which
│  │ package originally brings it in as a dependency.
│  └ @ Formatting ~/.julia/packages/Formatting/3VxOt/src/Formatting.jl:12
└  

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

No branches or pull requests

1 participant