Skip to content

Commit

Permalink
Implement suggestions made by @iantaylor-NOAA
Browse files Browse the repository at this point in the history
  • Loading branch information
kellijohnson-NOAA authored Sep 19, 2024
1 parent e988a75 commit 96bdc80
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions 06-developer-software-guide.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ To start a codespace on the FIMS repository, follow the [GitHub documentation fo

### git

To contribute to the code, you will need git installed locally, and you may prefer to use an additional git [GUI client](https://git-scm.com/downloads/guis) such as GitKraken or GitHub Desktop. See the section on [RStudio](#rstudio) for setting up RStudio to work with git.
To contribute to the code, you will need git installed locally, and you may prefer to use an additional git [GUI client](https://git-scm.com/downloads/guis) such as GitHub Desktop. See the section on [RStudio](#rstudio) and [VS Code](#vs-code) for setting up those editors to work with git.

To install git, please follow the operating-system specific instructions available in the [git documentation](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
To install git, please contact your IT department or follow the operating-system specific instructions available in the [git documentation](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).

### Development environment

Expand Down Expand Up @@ -78,12 +78,12 @@ Additional settings for R are available in the [extension wiki](https://github.c
}
```

Other helpful VS Code extensions are available in the VScode marketplace, e.g.,
Other helpful extensions for VS Code are available in the VScode marketplace, e.g.,
- Github Copilot: An AI tool that helps with line completion.
- Live Share: Collaborate on the same file remotely with other developers.
- Rewrap: Helps rewrapping comments and text lines at a specified character count. Note that to get it working it will be necessary to add [rulers](https://code.visualstudio.com/docs/getstarted/tips-and-tricks#_vertical-rulers).
- GitLens (or GitLess): Adds more Git functionality. Some of the GitLens functionality is not free, and GitLess is a fork before the addition of these premium features.
- Selecting "R: Launch Rstudio Addin" from the command pallete will provide a list of addin options for RStudio.
- A list of extensions that can help make VS Code operate more like RStudio is available by typing `R: Launch Rstudio Addin' in the command pallete.

#### RStudio

Expand Down
2 changes: 1 addition & 1 deletion 10-testing.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -376,6 +376,6 @@ test_that("TestName", {
Simulation results might be dependent on the order of calls, leading to failed tests just because different random numbers are used or the order of the simulation changes through model
development (see [FIMS-planning discussion 25](https://github.com/NOAA-FIMS/FIMS-planning/issues/25) for details). Below are some potential soluations.
- Add a TRUE/FALSE parameter in each FIMS simulation module for
setting up testing seed. When testing the module, set the paramter to
setting up testing seed. When testing the module, set the parameter to
TRUE to fix the seed number in R and conduct tests. If adding a TRUE/FALSE parameter does not work as expected, then carefully check simulated data from each component and make sure it is not a model coding error.
- Use `set.seed()` from R to set the seed and investigate using {rstream} to generate multiple streams of random numbers to associate distinct streams of random numbers with different sources of randomness. {rstream} was specifically designed to address the issue of needing very long streams of pseudo-random numbers for parallel computations. See [the rstream paper](https://www.iro.umontreal.ca/~lecuyer/myftp/papers/rstream.pdf) and [RngStreams](http://www-labs.iro.umontreal.ca/~lecuyer/myftp/streams00/) for more details.

0 comments on commit 96bdc80

Please sign in to comment.