Add link to AR6 region acronym definitions

[znicholls]

Pull request

Please confirm that this pull request has done the following:

• Tests added
• Documentation added (postponed to Document MAGICC's input and output formats more carefully #316)
• Example added (either to an existing notebook or as a new notebook, where applicable) (N/A)
• Description in CHANGELOG.rst added

Adding to CHANGELOG.rst

Please add a single line in the changelog notes similar to one of the following:

- (`#XX <http://link-to-pr.com>`_) Added feature which does something
- (`#XX <http://link-to-pr.com>`_) Fixed bug identified in (`#XX <http://link-to-issue.com>`_)

[znicholls]

If AR6 regions are included, an example file would look like

---- HEADER ----

Test mag file
For more information on the AR6 regions (including mapping the abbrevations to their full names), see: https://github.com/SantanderMetGroup/ATLAS/tree/master/reference-regions, specifically https://github.com/SantanderMetGroup/ATLAS/blob/master/reference-regions/IPCC-WGI-reference-regions-v4_coordinates.csv (paper is at https://doi.org/10.5194/essd-2019-258)

---- METADATA ----

other info: checking time point handling

&THISFILE_SPECIFICATIONS
    THISFILE_DATACOLUMNS = 5
    THISFILE_DATAROWS = 15
    THISFILE_FIRSTYEAR = 2099
    THISFILE_LASTYEAR = 2101
    THISFILE_ANNUALSTEPS = 0
    THISFILE_DATTYPE = 'MAG'
    THISFILE_REGIONMODE = 'NONE'
    THISFILE_TIMESERIESTYPE = 'MONTHLY'
    THISFILE_FIRSTDATAROW = 26
/

   VARIABLE                 NPP                 NPP                 NPP                 NPP                 NPP
       TODO                 SET                 SET                 SET                 SET                 SET
      UNITS             gCperyr             gCperyr             gCperyr             gCperyr             gCperyr
      YEARS               WORLD             AR6-ARO             AR6-NEN                LAND               OCEAN
2099.042000         0.00000e+00         1.00000e+00         2.00000e+00         3.00000e+00         4.00000e+00
2099.125000         5.00000e+00         6.00000e+00         7.00000e+00         8.00000e+00         9.00000e+00
2099.208000         1.00000e+01         1.10000e+01         1.20000e+01         1.30000e+01         1.40000e+01
2099.292000         1.50000e+01         1.60000e+01         1.70000e+01         1.80000e+01         1.90000e+01

[codecov]

Codecov Report

Merging #315 into master will decrease coverage by 0.02%.
The diff coverage is 80.00%.

@@            Coverage Diff             @@
##           master     #315      +/-   ##
==========================================
- Coverage   93.31%   93.29%   -0.03%     
==========================================
  Files          18       18              
  Lines        2485     2490       +5     
  Branches      484      486       +2     
==========================================
+ Hits         2319     2323       +4     
  Misses        105      105              
- Partials       61       62       +1     

Impacted Files	Coverage Δ
pymagicc/io/mag.py	94.73% <80.00%> (-1.04%)	⬇️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4972d10...627cfd8. Read the comment docs.

[lewisjared]

Looks great. Are you wanting to add more documentation or is it good to go?

[znicholls]

Are you wanting to add more documentation or is it good to go?

Not sure, what do you think? e.g. do we need to document this behaviour of adding lines to headers (also now that I think about it, if you read and re-wrote files repeatedly that line would be added over and over again which isn't ideal)?

[lewisjared]

I'm not sure how we would document that other than embedding an example of each of the MAGICC files into the docs. That's a job that probably needs to be done eventually.

Good pickup re the additional lines

[znicholls]

Yes or throwing a warning, one for another day

…

On Mon, 2 Nov 2020 at 12:37 pm, Jared Lewis ***@***.***> wrote: I'm not sure how we would document that other than embedding an example of each of the MAGICC files into the docs. That's a job that probably needs to be done eventually. Good pickup re the additional lines — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#315 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AFUH5G474BVGWDGWEIYLCZDSNYEMNANCNFSM4TG2MY2Q> .