FIMS
A software system designed and architected to support next-generation fisheries stock assessment, ecosystem, and socioeconomic modeling.
https://github.com/noaa-fims/fims
Category: Biosphere
Sub Category: Marine Life and Fishery
Keywords
noaa-nsap r-package stock-assessment
Keywords from Contributors
fisheries fisheries-stock-assessment stock-synthesis latex noaa noaa-fisheries
Last synced: about 2 hours ago
JSON representation
Repository metadata
The repository for development of FIMS
- Host: GitHub
- URL: https://github.com/noaa-fims/fims
- Owner: NOAA-FIMS
- License: gpl-3.0
- Created: 2022-01-25T19:21:58.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2026-08-05T23:37:52.000Z (6 days ago)
- Last Synced: 2026-08-06T06:02:41.700Z (5 days ago)
- Topics: noaa-nsap, r-package, stock-assessment
- Language: C++
- Homepage: https://noaa-fims.github.io/FIMS/
- Size: 229 MB
- Stars: 40
- Watchers: 13
- Forks: 37
- Open Issues: 143
- Releases: 21
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
README.md
Overview
FIMS is an R package for fitting integrated statistical population-dynamics models to fishery data. The back end is written in C++, and the use of Rcpp allows users to easily interact with the models using R. The package is unique because it includes multiple model types, e.g., surplus production and catch-at-age models. This reduces the burden of learning a new framework when exploring major changes in model structure. Stay tuned for the addition of even more model types.
If you are new to FIMS, the best place to start is the "Introducing FIMS" vignette.
Installation
A precompiled version of the latest release is available from the instance of R universe hosted by NOAA Fisheries Integrated Toolbox. You can install the latest version from GitHub.
# Install the pre-compiled version of the latest release
install.packages(
"FIMS",
repos = c(
"https://noaa-fisheries-integrated-toolbox.r-universe.dev",
"https://cloud.r-project.org"
)
)
# Compile and install it yourself, where you can specify the branch
pak::pak("NOAA-FIMS/FIMS@main")
Developers who are interested in building FIMS can clone this repository, e.g., git clone https://github.com/NOAA-FIMS/FIMS.git and build it with devtools::install(), which builds the package from the cloned files and installs the R library. Installing with devtools::load_all() is not recommended because it uses shim files for things like system.file(), which can cause FIMS to not function as expected. For example, if you try to optimize the same model twice, you will more than likely not get estimates of uncertainty from the second model run. Additionally, devtools::load_all() adds the debugger flag -O0 -g which leads to Windows users seeing Fatal error: can't write <xxx> bytes to section .text of FIMS.o: 'file too big. Thus, Windows users need to run withr::local_options(pkg.build_extra_flags = FALSE) at the beginning of every R session before calling devtools::load_all(). If you want to compile FIMS with the debugger turned on you will need to run the {withr} function in addition to manually modifying the call to PKG_CXXFLAGS in the src/Makevars.win file to include -O1 -g.
A comprehensive list of all the tools needed to build, test, and document FIMS can be found here. Additionally, information on best practices regarding how to install each requirement can be found on the NOAA Fisheries Office of Science and Technology on- and off-boarding repository.
Cheatsheet
Usage
library(FIMS)
# Load sample data
data("data_big")
# Prepare data for FIMS model
data_4_model <- FIMSFrame(data_big)
# Create parameters
parameters <- data_4_model |>
create_default_configurations() |>
create_default_parameters(data = data_4_model)
# Run the model with optimization
fit <- parameters |>
initialize_fims(data = data_4_model) |>
fit_fims(optimize = TRUE)
# Clear memory post-run
clear()
Troubleshooting
If you encounter a 🐛, please file an Issue with a minimal reproducible example on GitHub.
If you are uncertain that you have actually encountered a 🐛, are looking for more information, or want to talk about some new ideas please use the Discussion Board to post your thoughts. Anyone interested in our project is welcome to join the discussions, this is a place for all members of the assessment and open-source software community to ask and answer questions, share updates, have open-ended conversations, and follow along. Please introduce yourself 👋 on the Introduction Discussion.
More information can be found on the NOAA-FIMS website, particularly on our blog.
NOAA 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 code 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.
Software code created by U.S. Government employees is not subject to copyright in the United States (17 U.S.C. section 105). The United States/Department of Commerce reserve all rights to seek and obtain copyright protection in countries other than the United States for Software authored in its entirety by the Department of Commerce. To this end, the Department of Commerce hereby grants to Recipient a royalty-free, nonexclusive license to use, copy, and create derivative works of the Software outside of the United States.
U.S. Department of Commerce | National Oceanic and Atmospheric Administration | NOAA Fisheries
Owner metadata
- Name: NOAA-FIMS
- Login: NOAA-FIMS
- Email:
- Kind: organization
- Description:
- Website:
- Location:
- Twitter:
- Company:
- Icon url: https://avatars.githubusercontent.com/u/79874876?v=4
- Repositories: 13
- Last ynced at: 2023-03-05T20:38:40.115Z
- Profile URL: https://github.com/NOAA-FIMS
GitHub Events
Total
- Create event: 318
- Commit comment event: 21
- Release event: 7
- Delete event: 330
- Member event: 1
- Pull request event: 419
- Fork event: 15
- Discussion event: 6
- Issues event: 324
- Watch event: 12
- Issue comment event: 1059
- Push event: 1881
- Pull request review comment event: 494
- Pull request review event: 494
Last Year
- Delete event: 174
- Pull request event: 158
- Fork event: 6
- Discussion event: 6
- Issues event: 206
- Watch event: 3
- Issue comment event: 376
- Push event: 987
- Pull request review comment event: 216
- Pull request review event: 170
- Create event: 153
- Commit comment event: 6
Committers metadata
Last synced: 1 day ago
Total Commits: 1,592
Total Committers: 37
Avg Commits per committer: 43.027
Development Distribution Score (DDS): 0.75
Commits in past year: 259
Committers in past year: 22
Avg Commits per committer in past year: 11.773
Development Distribution Score (DDS) in past year: 0.587
| Name | Commits | |
|---|---|---|
| Christine Stawitz - NOAA | 4****A | 398 |
| Bai Li | b****i@n****v | 234 |
| Andrea-Havron-NOAA | a****n@n****v | 228 |
| kellijohnson-NOAA | k****n@n****v | 181 |
| Matthew-Supernaw-NOAA | m****w@n****v | 163 |
| Kathryn Doering | k****g@n****v | 115 |
| github-actions[bot] | 4****] | 70 |
| Nathan Vaughan | n****n@n****v | 43 |
| Christine.Stawitz | c****z | 22 |
| copilot-swe-agent[bot] | 1****t | 21 |
| dependabot[bot] | 4****] | 16 |
| Jane Sullivan | j****n@n****v | 13 |
| Eshaan | e****a@g****m | 13 |
| Elizabeth Perl | e****i@n****v | 8 |
| Dr. Wilson | 1****a | 8 |
| Szu-Yun | s****n@n****m | 7 |
| Jon Kenton Tarsus Brodziak | j****k@n****v | 6 |
| MOshima-PIFSC | m****a@n****v | 6 |
| Ian Taylor | i****r@n****v | 6 |
| Elizabeth Perl | e****l@n****v | 4 |
| Rohith-1717 | d****p@g****m | 4 |
| Eric Ward | 5****a | 3 |
| alexjensen-NOAA | 1****A | 3 |
| peterkuriyama-NOAA | 1****A | 3 |
| timjmiller | t****r@n****v | 2 |
| KyleShertzer-NOAA | 8****A | 2 |
| Aman Raj | s****0@g****m | 2 |
| Abhinav Kumar | a****3@g****m | 2 |
| Lukas Novotny | l****o@l****z | 1 |
| Mark C | m****n@u****u | 1 |
| and 7 more... | ||
Committer domains:
- noaa.gov: 13
- students.riphah.edu.pk: 1
- umich.edu: 1
- lno.cz: 1
- ntu.im: 1
Issue and Pull Request metadata
Last synced: about 16 hours ago
Total issues: 366
Total pull requests: 486
Average time to close issues: 5 months
Average time to close pull requests: 8 days
Total issue authors: 26
Total pull request authors: 32
Average comments per issue: 3.55
Average comments per pull request: 2.97
Merged pull request: 269
Bot issues: 1
Bot pull requests: 42
Past year issues: 38
Past year pull requests: 74
Past year average time to close issues: about 1 month
Past year average time to close pull requests: 6 days
Past year issue authors: 11
Past year pull request authors: 17
Past year average comments per issue: 2.16
Past year average comments per pull request: 3.36
Past year merged pull request: 30
Past year bot issues: 1
Past year bot pull requests: 13
Top Issue Authors
- kellijohnson-NOAA (75)
- Andrea-Havron-NOAA (65)
- ChristineStawitz-NOAA (64)
- Bai-Li-NOAA (63)
- k-doering-NOAA (34)
- msupernaw (17)
- JaneSullivan-NOAA (10)
- iantaylor-NOAA (5)
- nathanvaughan-NOAA (5)
- awilnoaa (5)
- Cole-Monnahan-NOAA (4)
- e-perl-NOAA (3)
- KyleShertzer-NOAA (2)
- MOshima-PIFSC (2)
- github-actions[bot] (1)
Top Pull Request Authors
- kellijohnson-NOAA (115)
- ChristineStawitz-NOAA (78)
- Bai-Li-NOAA (70)
- Andrea-Havron-NOAA (48)
- k-doering-NOAA (40)
- github-actions[bot] (25)
- dependabot[bot] (17)
- msupernaw (14)
- Srajald (10)
- nathanvaughan-NOAA (8)
- abhinav-1305 (8)
- MOshima-PIFSC (6)
- iantaylor-NOAA (6)
- e-perl-NOAA (4)
- JaneSullivan-NOAA (4)
Top Issue Labels
- kind: refactor (83)
- status: triage_needed (77)
- status: in progress (36)
- kind: documentation (29)
- status: needs discussion (27)
- kind: bug (26)
- P3 (26)
- attribute: low hanging 🍎 (25)
- kind: test case (22)
- P1 (20)
- theme: NLL refactor (20)
- theme: code cleanup (19)
- kind: question (18)
- P2 (17)
- kind: feature (17)
- low hanging 🍎 (10)
- attribute: case study features (10)
- sprint 1 (9)
- theme: documentation (8)
- theme: r interface (8)
- theme: more features (6)
- good first issue (6)
- attribute: needs discussion (5)
- theme: pilot studies (5)
- attribute: good first issue (5)
- status: in dev (4)
- github_actions (4)
- theme: R interface (4)
- dependencies (4)
- kind: vignette (3)
Top Pull Request Labels
- dependencies (17)
- auto-update (17)
- github_actions (17)
- kind: documentation (13)
- theme: code cleanup (11)
- P3 (11)
- kind: bug (10)
- kind: refactor (10)
- theme: R interface (6)
- theme: documentation (6)
- kind: feature (4)
- status: in progress (3)
- theme: more features (2)
- attribute: low hanging 🍎 (2)
- status: needs discussion (1)
- vignette (1)
Package metadata
- Total packages: 2
- Total downloads: unknown
- Total dependent packages: 0 (may contain duplicates)
- Total dependent repositories: 0 (may contain duplicates)
- Total versions: 38
proxy.golang.org: github.com/NOAA-FIMS/FIMS
- Homepage:
- Documentation: https://pkg.go.dev/github.com/NOAA-FIMS/FIMS#section-documentation
- Licenses: gpl-3.0
- Latest release: v0.9.4 (published 13 days ago)
- Last Synced: 2026-08-11T12:06:30.284Z (about 2 hours ago)
- Versions: 19
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent packages count: 5.395%
- Average: 5.576%
- Dependent repos count: 5.758%
proxy.golang.org: github.com/noaa-fims/fims
- Homepage:
- Documentation: https://pkg.go.dev/github.com/noaa-fims/fims#section-documentation
- Licenses: gpl-3.0
- Latest release: v0.9.4 (published 13 days ago)
- Last Synced: 2026-08-11T12:06:30.384Z (about 2 hours ago)
- Versions: 19
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent packages count: 5.395%
- Average: 5.576%
- Dependent repos count: 5.758%
Dependencies
- R >= 3.4 depends
- Rcpp * imports
- TMB >= 1.8.0 imports
- usethis * imports
- covr * suggests
- testthat >= 3.0.0 suggests
- actions/checkout v3 composite
- actions/checkout v3 composite
- actions/github-script 0.3.0 composite
- DoozyX/clang-format-lint-action v0.14 composite
- actions/checkout v3 composite
- peter-evans/create-pull-request v4 composite
- actions/checkout v3 composite
- actions/checkout v3 composite
- actions/upload-artifact v3 composite
- codecov/codecov-action v3 composite
- seanmiddleditch/gha-setup-ninja master composite
- actions/checkout v3 composite
- actions/upload-artifact v3 composite
- codecov/codecov-action v3 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite
- actions/checkout v6 composite
- peter-evans/create-pull-request v7 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite
- actions/first-interaction v3 composite
- actions/checkout v6 composite
- actions/upload-artifact v5 composite
- peaceiris/actions-gh-pages v4 composite
- r-lib/actions/setup-pandoc v2 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite
Score: -Infinity