diff --git a/NEWS.md b/NEWS.md new file mode 100644 index 0000000..0e696a7 --- /dev/null +++ b/NEWS.md @@ -0,0 +1,92 @@ +Version 2.0.0 (2021-04-12) +------------------------------ + +**Readme sheet** + +* Defined table object Version. + + +**Metadata sheet** + +* Removed Stock_Information table object definition. + +* Added Countries. + +* Added Assessment Type. + +* Added Reporting Year. + +* Defined table object From_TimeSeries. + +* Renamed table object Advice_Table -> For_Advice. + +* Formatted GSA cells as text in Metadata, to make them easier to type directly. + +* Changed label Assessment Year -> Reference Year. + +* Quantitative Status is only calculated if Validation Status is Quantitative. + +* Rearranged B reference point section to a flat layout. + +* Rearranged VPA-Type Model and Forecast Included to a horizontal layout. + +* Stock Status Text is calculated automatically, instead of requiring user + input. + +* B0.33 and B0.66 are calculated automatically, instead of requiring user input. + + +**TimeSeries sheet** + +* Renamed sheet Summary -> TimeSeries. + +* Rearranged unit cells, so they are close to the corresponding columns. + +* Renamed table object Summary_Table -> TS_Table. + +* Changed label Fishing Pressure Type -> Exploitation Unit. + +* Removed Effort_lower, Effort, and Effort_upper columns. + + +**Vocabularies sheet** + +* Added Countries. + +* Added Assessment Type. + +* Extended Year range from 2021 to 2025. + +* Changed Exploitation Unit options to F, HR, and Effort. + +* Removed Stock Status. + + +**Advice sheet** + +* Added intermediate calculations to shorten formulas. + +* B0.33 and B0.66 are not exported as Reference Points, but do form the basis of + the Stock Status. + +* Formatted Fc and Quantitative Status to 0.00 format, with trailing zeroes. + +* Quantitative Status with respect to F is reported as F/Fref or E/Eref, rather + than F/Ftarget. + +* Quantitative Status with respect to B is based on Bmsy, Bpa, and Blim - not on + B0.33 or B0.66. + +* Added GSA_Countries table object, containing comma-separated GSA Names and + Countries. + + + + +Version 1.0.0 (2021-01-15) +-------------------------- + +* First version of the Excel STAR template. + +* Launched at joint plenary session of the Mediterranean stock assessment + working groups (2021-01-18). diff --git a/README.md b/README.md index 6d0d51c..016efbe 100644 --- a/README.md +++ b/README.md @@ -13,19 +13,23 @@ Mediterranean and the Black Sea. -## Download newest version of Excel template +## Download newest Excel template -*2021-01-15* +*Version 2.0.0* -* [star-template.xlsx](https://github.com/gfcm/star/releases/download/2021-01-15/star_template.xlsx) +*12 Apr 2021* + +* [star-template.xlsx](https://github.com/gfcm/star/releases/download/2.0.0/star_template.xlsx) +* [NEWS.md](https://github.com/gfcm/star/blob/main/NEWS.md) ## User documentation -Guidelines for users is provided in three places: +Guidelines for users are provided in four places: -1. Usage comments within the +1. Overview of the STAR framework and wider context in the launch event + [presentation](2021_01_18_launch_event.pdf) +2. Usage comments within the [Excel template](https://github.com/gfcm/star/raw/main/star_template.xlsx) sheets -2. Sheet highlighting the [logic](logic.pdf) behind the Excel formulas -3. Overview of the STAR framework and wider context in the launch event - [presentation](2021_01_18_launch_event.pdf) +3. Sheet highlighting the [logic](logic.pdf) behind the Excel formulas +4. User-visible changes are listed in the [NEWS.md](NEWS.md) version history diff --git a/star_template.xlsx b/star_template.xlsx index 009ec88..112ad44 100755 Binary files a/star_template.xlsx and b/star_template.xlsx differ