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.

Sign up for GitHub

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

Jump to bottom

New Docs pages request #153

Closed
7 tasks done
odunbar opened this issue Apr 27, 2022 · 3 comments
Closed
7 tasks done

New Docs pages request #153

odunbar opened this issue Apr 27, 2022 · 3 comments
Assignees
@eviatarbach @jinlong83 @ilopezgp @odunbar
Labels
help wanted Extra attention is needed

Comments

@odunbar
Copy link
Member

odunbar commented Apr 27, 2022 •
edited
Loading

New Pages

  • DataContainers
  • failure handling in the different particle methods - Ignacio
  • Use cases HPC vs "local julia" implementation (see e.g. the response in Small question: parallellization #148) (pmap/distributed vs SLURM & new file interface) - Haakon/Melanie/Ollie
  • Sparse EKI documentation - (Jinlong)
  • Localization and sampling error correction - Ignacio
  • Extra info on SEC and localization example with Lorenz 96 (a commented version of the current test would work) - Eviatar
  • Recommended settings of "bells and whistles" (localization/regularization/inflation...)

Please add suggestions below!
@ilopezgp ilopezgp added the help wanted Extra attention is needed label May 11, 2022
@odunbar
Copy link
Member Author

odunbar commented May 23, 2022

@haakon-e see the 2nd point here. I've added you to the issue

@odunbar odunbar mentioned this issue Jul 7, 2022
Merged
5 tasks
bors bot added a commit that referenced this issue Jul 29, 2022
@bors @odunbar
Merge #179
e30f2f9 
179: Docs for data container and HPC  r=odunbar a=odunbar

## Purpose and Content
add two docs pages requested in Issues #153 , closes #148
- DataContainers page
- HPC and Parallelism page

adds an example to demonstrate all of the different parallelism types (serial, multithread, pmap and distributed for)
- `distributed_Lorenz_example.jl`


## PR Checklist
- [x] This PR has a corresponding issue OR is linked to an SDI.
- [x] I have followed CliMA's codebase [contribution](https://clima.github.io/ClimateMachine.jl/latest/Contributing/) and [style](https://clima.github.io/ClimateMachine.jl/latest/DevDocs/CodeStyle/) guidelines OR N/A.
- [x] I have followed CliMA's [documentation policy](https://github.com/CliMA/policies/wiki/Documentation-Policy).
- [x] I have checked all issues and PRs and I certify that this PR does not duplicate an open PR.
- [x] Documentation has been added/updated OR N/A.


Co-authored-by: odunbar <[email protected]>
@ilopezgp
Copy link
Contributor

ilopezgp commented Aug 23, 2022 •
edited
Loading

Localization documentation will be added in #189.

We still need the documentation of SparseEKI, with a warning sign about its lack of robustness unless issues discussed in #134 and #146 are fixed. @jinlong83

Anything other than localization that we want to add as bells and whistles, @odunbar ? Since we do not have more in the source code, maybe best to leave it at that for now.

@odunbar
Copy link
Member Author

odunbar commented Jan 20, 2023

Completed with JOSS paper submission

@odunbar odunbar closed this as completed Jan 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@eviatarbach eviatarbach

@jinlong83 jinlong83

@ilopezgp ilopezgp

@odunbar odunbar

Labels
help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@eviatarbach @jinlong83 @ilopezgp @odunbar