Description
Project Description
The Fisheries Integrated Modeling System (FIMS) is a framework to create statistical models, written in C++ and R, to assess the status of marine resources. Currently, there is a logging system that is integrated throughout the C++ that logs information, warnings, and errors. The system is incomplete in that not all information is being stored that could be relevant to users. This project would take examples already in the source code and use pattern matching to insert new logging entries into the code where it seems that they are needed. Additionally, the vignette for how to use the logging system could be expanded upon.
Expected Outcomes
Three major outcomes are expected from this project, (1) more information is logged due to increased use of the logging system within the C++ code base, (2) the logging system is tested within both R and C++ test suites, and (3) users have clear instructions on how to use the logging system. Many users of FIMS do not know C++ code, and thus, the logging system is pertinent for users to know which part of the C++ code, i.e., line number, is relevant. The logging system will help get a large number of users up to speed with FIMS in the shortest amount of time because it can act as a virtual help desk.
Skills Required
C++, json, R - suggested, GitHub - suggested
Additional Background/Issues
- Example in C++ where a log entry is created
- vignette
- Issue 750 enhance links in logging vignette to doxygen documentation
Mentor(s)
Kelli Johnson (@kellijohnson-NOAA), Matthew Supernaw (@msupernaw)
Mentor Contact Email(s)
[email protected], [email protected]
Expected Project Size
90 hours
Project Difficulty
Intermediate