Restart work on TAF -> SAG

[colinpmillar]

WGTAFGOV issue: ices-eg/wg_WGTAFGOV/issues/28

• [x] @colinpmillar and @cekv to have scoping meeting
• [x] develop list of tasks from meeting
• [ ] convert to issues
• [ ] organise teams meeting with issue contributors

[colinpmillar]

Scoping meeting set for Weds 17/11/2021

[colinpmillar]

Meeting produced this:

Need to convert this to a list of tasks

[colinpmillar]

Bullet list of issues:

• create output table in DB
  • RepoID
  • (Name)
  • output type (SAG, CatchOptions, Index etc)
  • Commit reference
  • Time stamp
• create list of official assessments table in DB
  • RepoID
  • Stock
  • Year
  • Commit
  • timestamp
• Button to register outputs
  • update list of outputs table, or create entry if not one already.
  • it will overwrite on a repo level, so there will only be one commit per repo entry, i.e. no multiple versions per repo.
  • will need to delete all outputs if present, and write new ones. because output types per repo can change and user develops their analysis.
  • Should the button find the output files and allow user to select which ones are 'exported' or in otherwords incvluded in the table.
  • should the user be able to select the types themselves, even if the output files are not in the repository
  • should the button run the output files through the appropriate DATSU checks and report back, and only allow the entry into the table if the DATSU checks pass? (we think it should)
• Button to copy to SAG / button to tag final assessment
  • updates table of final assessments with repoId, stock, year and commit + timestamp
  • checks if that repo is in the table, and updates commit ref and timestamp if it does
  • needs to check if there are official outputs, and if so, check that the commit refs are the same. If different, then tell user to update official output table first.
  • If there is a SAG output present, upload to SAG
  • check that there is only one SAG output for a stock year combination. report error message to user: SAG output already registered for this stock, year. We could list what might be wrong: a) another repo is tagged as the final assessent, b) another repo, that is part of the final assessment, is producing a SAG output.

Notes:

• List of outputs table allows a user to register and output type with a repository
• List of final assessments allows the user to tag the official assessment (repo + commit)
• The official SAG output is a join of list of outputs table and list of final assessments where output == "SAG"
• Repo can be updated after final assessment 'tagged' and will only go into both tables when the user clicks a button.

[colinpmillar]

User experience:

1. code up assessment
2. create outputs of correct format in the output folder
3. register outputs (button / api)
4. modify / develop code
5. reregister outputs (button / api)
6. Publish to SAG / flag as proposed final

?7. Make final and publish

4, and 5 can be repeated, also 4, 5, and 6, as part of a development cycle.

[colinpmillar]

Two tasks done: https://github.com/ices-taf/doc/issues/288 https://github.com/ices-taf/doc/issues/289

[Milldaz]

On this part: check that there is only one SAG output for a stock year combination. report error message to user: SAG output already registered for this stock, year. We could list what might be wrong: a) another repo is tagged as the final assessent, b) another repo, that is part of the final assessment, is producing a SAG output.

You would need to check the 'Purpose' - there should be only one 'Advice' but there is no limit on other purposes. When uploading to SAG when an assessment exists already for that year you are asked to choose whether you overwrite or upload a new one. May need to have a similar option to choose when pushing from TAF.