diff --git a/04-user-guide.Rmd b/04-user-guide.Rmd index 2afae98..182f47f 100644 --- a/04-user-guide.Rmd +++ b/04-user-guide.Rmd @@ -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: @@ -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). diff --git a/06-developer-software-guide.Rmd b/06-developer-software-guide.Rmd index c8992a0..0c75c67 100644 --- a/06-developer-software-guide.Rmd +++ b/06-developer-software-guide.Rmd @@ -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 @@ -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) - -