climr icon indicating copy to clipboard operation
climr copied to clipboard

Read through documentation

Open CeresBarros opened this issue 1 year ago • 6 comments

Current documentation needs a thorough read through to ensure clarity and completeness.

CeresBarros avatar Feb 16 '24 20:02 CeresBarros

@cmahony did #214 and #212 fix this?

CeresBarros avatar Feb 27 '24 18:02 CeresBarros

partially. those got it to v0.0.3. we need a full read-through before releasing v1. keeping this open until then.

cmahony avatar Feb 27 '24 18:02 cmahony

One documentation note is that I think the use of low and high resolution are reversed in the Readme: "a simple method that adds low-spatial-resolution climate anomalies to a high-spatial-resolution reference climatological map" I think it is used correctly further down: "A high resolution composite climatology of BC PRISM," but it might be good to check other parts of the docs.

Looking forward to using this package!!

see24 avatar Feb 29 '24 17:02 see24

Thanks @see24 ! @cmahony can you have a look please?

CeresBarros avatar Feb 29 '24 17:02 CeresBarros

Hi @see24, thanks for looking through the documentation! the wording is correct as is. the anomalies are from GCMs at 60-250km resolution ("low resolution"), and the reference climate map is at 800m resolution ("high resolution"). thanks for checking on this. please let us know if you see any other possible issues.

cmahony avatar Feb 29 '24 17:02 cmahony

Ah my bad!

see24 avatar Feb 29 '24 17:02 see24