Reorganise r-env documentation#2905
Closed
helijuottonen wants to merge 3 commits intomasterfrom
Closed
Conversation
b2dd0ab to
04b0c54
Compare
Member
Author
|
Closed because I managed to create a Git mess. Will create a new pull request for this. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Proposed changes
Big re-organisation of r-env documentation
Shortening the main r-env page and removing some less relevant content. Aim is to help people find the most important information more easily, and the page had grown too long.
https://csc-guide-preview.2.rahtiapp.fi/origin/renv_big_update/apps/r-env/
Moving all examples of parallel batch jobs to separate page and adding separate tabs for Puhti and Mahti (and Roihu to be added soon). Idea here is that people who know what they are doing are able to add more cores based on the basic batch job script template in the main documentation, and others need more information. Some examples have been updated, especially MPI examples to emphasize that they are meant for jobs using multiple nodes and more cores than a single node has. For example, to take into account that it is unnecessarily complicated to use MPI with R for something that needs 8 cores.
https://csc-guide-preview.2.rahtiapp.fi/origin/renv_big_update/support/tutorials/parallel-r-examples/
Small updates to the parallel R tutorial:
https://csc-guide-preview.2.rahtiapp.fi/origin/renv_big_update/support/tutorials/parallel-r/
Checklist before requesting a review