Skip to content

NOAA-FIMS/case-studies

Repository files navigation

FIMS case studies

This is a website (type: website) showcasing test cases of the Fisheries Integrated Modeling System.

Case studies included so far:

Stock Status
NEFSC yellowtail flounder working
AFSC GOA pollock working
AFSC BSAI Atka Mackerel working
SWFSC sardine working
NWFSC petrale working
PIFSC opakapaka working
SEFSC scamp working

How to add a case study

  • Create a new branch to work on a case study.
  • Edit the qmd or md files in the content folder. qmd files can include code (R) and lots of Quarto markdown bells and whistles (like call-outs, cross-references, auto-citations and much more).
  • Add the files to _quarto.yml.
  • Submit a pull request when finished working on a case study. If the case study renders successfully, the rendered pages will be uploaded to the artifacts section of the GitHub Actions page. If the case study fails to render, developers can review the GitHub Actions log to debug.

How to use codespaces

See the GitHub codespaces documentation for general codespaces help.

After launching a codespace, to code in Rstudio rather than VSCode, type rserver into the command line.

If needed for use, reshape2 will need to be install on the R terminal using install.packages("reshape2"). It was failing to install as part of the codespaces devcontainer.json file, and so was not included for now.

gdb is installed in the codespace.

Disclaimer

This repository is a scientific product and is not official communication of the National Oceanic and Atmospheric Administration, or the United States Department of Commerce. All NOAA GitHub project content is provided on an ‘as is’ basis and the user assumes responsibility for its use. Any claims against the Department of Commerce or Department of Commerce bureaus stemming from the use of this GitHub project will be governed by all applicable Federal law. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by the Department of Commerce. The Department of Commerce seal and logo, or the seal and logo of a DOC bureau, shall not be used in any manner to imply endorsement of any commercial product or activity by DOC or the United States Government.

License

This content was created by U.S. Government employees as part of their official duties. This content is not subject to copyright in the United States (17 U.S.C. §105) and is in the public domain within the United States of America. Additionally, copyright is waived worldwide through the CC0 1.0 Universal public domain dedication.