nmfs-ost / ss3-doc

Source code for the Stock Synthesis manual and other documentation
https://nmfs-ost.github.io/ss3-website/
Creative Commons Zero v1.0 Universal
4 stars 2 forks source link

Add details about recruitment distribution #6

Closed k-doering-NOAA closed 3 years ago

k-doering-NOAA commented 4 years ago

Imported from redmine, Issue #83940 Opened by @k-doering-NOAA on 2020-10-16 Status when imported: New

Thanks to Vlada for pointing out there isn't much explanation about recruitment distribution in the manual. I think it would be helpful to add a few sentences on how recruitment distribution works (esp. in the more complex case of having different recruitments for different growth patterns, areas, or seasons).

In particular, which values are acceptable for the parameter line inputs is not explained at all - I think all inputs should be between 0 and 1? Does SS rescale them if they aren't? This should be addressed in the manual (perhaps by expanding the description of the parameter line inputs for recruitment distribution in the MG parms section)

k-doering-NOAA commented 4 years ago

comment from @iantaylor-NOAA on 2020-10-19: I'm seeing a reasonable amount of information under "Recruitment Distribution and Parameters" starting on page 77 of the 3.30.16 manual: [image: image.png]

On Fri, Oct 16, 2020 at 9:40 AM vlab.redmine@noaa.gov wrote:

k-doering-NOAA commented 4 years ago

comment from @k-doering-NOAA on 2020-10-19: You are right, @ian.taylor, thanks! I think the mistake I made was looking at the MG parms section of the manual and didn't see any information (or, it was Friday and I didn't look hard enough).

Maybe it would be worth adding a link back to this info in the section where the parameter lines for recruitment distribution are shown? Feel free to reject, though, if it seems unnecessary.

I also did notice a slight error (I think) in the parameter line setup:

COND: Recruitment Distribution 3 parameters lines defining recruitment distribution.
Method = 2 or 3
Recruitment Dist. GP Recruitment apportionment by growth pattern, if multiple growth patterns, multiple entries required.
Recruitment Dist. Area Recruitment apportionment by area, if multiple areas, multiple entries required.
Recruitment Dist. Month Recruitment apportionment by month, if multiple months, multiple entries required.

This says that 3 parameter lines are needed, but I think for method 3, it is 1 line/settlement recruitment assignment, while for method 2, it is one line for each growth pattern, area, and month(seasons???) defined in the model. The control helper spreadsheet has an example of these setups, which I think should be correct (although the parameter values may not be reasonable).

k-doering-NOAA commented 4 years ago

comment from @iantaylor-NOAA on 2020-10-19: I think links back and forth between those sections makes sense.

The User Manual explanation of the parameter lines seems correct for Method 2, but should be changed for Method 3. I would rename the "COND: Recruitment Distribution Method = 2 or 3" section to just for Method 2 and then add something like the following for Method 3 (where it probably makes sense to show at least 2 settlement parameters since a model with only 1 settlement event should be using Method 4):

COND: Recruitment Distribution Method = 3 1 parameter line for each settlement event defining the distribution of recruitment among them Recruitment Dist. 1 Recruitment apportionment parameter for the 1st settlement event Recruitment Dist. 2 Recruitment apportionment parameter for the 2nd settlement event … …

The help spreadsheet looks fine. For consistency with the User Manual, those parameters fixed at 1 could be changed to be fixed at 0 and have only the first parameter fixed for every dimension with more than one apportionment parameter. My suggested changes shown in the red numbers below:

Method 3:

_LO HI INIT PRIOR PR_SD PR_type PHASE Label

-4 4 0 0 99 0 -3 .. #RecrDist_GP_1_area_1_month_6 -4 4 0 0 99 0 3 … #RecrDist_GP_2_area_1_month_6 -4 4 -0.1 0 99 0 3 … #RecrDist_GP_1_area_2_month_6

Method 2:

_LO HI INIT PRIOR PR_SD PR_type PHASE Label

-4 4 0 0 99 0 -3 … #RecrDist_GP_1 -4 4 0 0 99 0 3 … #RecrDist_GP_2 -4 4 0 0 99 0 -3 … #RecrDist_Area_1 -4 4 -0.1 0 99 0 3 … #RecrDist_Area_2 -4 4 0 0 99 0 -3 … #RecrDist_month_6 On Mon, Oct 19, 2020 at 9:58 AM vlab.redmine@noaa.gov wrote:

k-doering-NOAA commented 4 years ago

comment from @RickMethot on 2020-10-20: This is looking good. Let me know if you want me to review a preview of the final. Also please take a look at the SSI in this regard.

k-doering-NOAA commented 4 years ago

comment from @iantaylor-NOAA on 2020-10-20: I just realized that the red colors I pasted into my email response didn't show up in Redmine. The modified helper spreadsheet with red coloring is attached.

On Tue, Oct 20, 2020 at 8:35 AM vlab.redmine@noaa.gov wrote:

k-doering-NOAA commented 3 years ago

fixed recruitment dist par lines in manual for method 3, and added a link from the parameter lines in MG params section to the rec apportionment details.