Skip to content

Commit

Permalink
PR changes suggested by @kellijohnson-NOAA
Browse files Browse the repository at this point in the history
  • Loading branch information
k-doering-NOAA authored Jun 21, 2024
1 parent 96b001c commit 53b22fd
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 45 deletions.
40 changes: 3 additions & 37 deletions 04-user-guide.Rmd
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
# User guide

This section details installation guides for
[users](#user-installation-guide). See the [developer installation
[users](#user-installation-guide). For developers, see the [developer installation
guide](#developer-software-and-installation-guide).

## User Installation Guide
This section describes how to install the FIMS R package and dependencies.

## Installing the package from R universe

The following software is required:
Expand All @@ -18,37 +15,6 @@ Install the latest precompiled version [FIMS from R universe](https://noaa-fims
install.packages("FIMS", repos = c("https://noaa-fims.r-universe.dev", "https://cloud.r-project.org"))
```

## Running the model

This section describes how to set-up and run the model.

### Specifying the model

#### Naming conventions
TODO: add description and link to naming conventions

#### Structuing data input
You can add components to the model using S4 classes.
```{r}
#TODO: add script to demonstrate how to structure data input
```

#### Defining model specifications
```{r}
#TODO: add scripts detailing how to set up different components of the model
```

### How to run the model
```{r}
#TODO: add script with examples on how to run the model
```

### Extracting model output

Here is how you get the model output.

```{r}
#Todo add code for how to extract model output
```

## Running FIMS

See the [Introducing FIMS vignette](https://noaa-fims.github.io/FIMS/articles/fims-demo.html).

This comment has been minimized.

Copy link
@kellijohnson-NOAA

kellijohnson-NOAA Jun 21, 2024

Collaborator

🙏 @k-doering-NOAA for leaving "breadcrumbs" for readers. I have been reading about good documentation and this is a "key" aspect that has been listed.

@iantaylor-NOAA would this change be sufficient for you to close #117?

This comment has been minimized.

Copy link
@iantaylor-NOAA

iantaylor-NOAA Jun 21, 2024

Contributor

Yes looks good.

Closes #117.

(not sure if review comments are adequate to close an issue, but if not I can close manually after this PR is merged).

9 changes: 1 addition & 8 deletions 06-developer-software-guide.Rmd
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
# Developer Software and Installation Guide

This section describes the software you will
need to contribute to this project as well as ways FIMS can be installed. This is in addition to the software
dependencies described in the [user installation
guide](#user-installation-guide) which you should ensure are installed
first.
need to contribute to this project as well as ways FIMS can be installed.

## Codespaces as an alternative to installing software

Expand Down Expand Up @@ -282,8 +279,4 @@ PKG_CXXFLAGS = -DTMB_MODEL -DTMB_EIGEN_DISABLE_WARNINGS
## Getting Help
Please report bugs along with a minimal reproducible example on GitHub [Issues](https://github.com/NOAA-FIMS/FIMS/issues)

## Code of Conduct
All contributors participating and contributing to the FIMS project are expected to adhere to the [FIMS Code of Conduct](https://noaa-fims.github.io/collaborative_workflow/code-of-conduct.html#code-of-conduct)



0 comments on commit 53b22fd

Please sign in to comment.