Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc updates #184

Merged
merged 13 commits into from
Dec 6, 2024
Merged

Doc updates #184

merged 13 commits into from
Dec 6, 2024

Conversation

RuthBowyer
Copy link
Collaborator

This PR updates the main readme and a few other bits. Thanks!

Copy link
Collaborator

@andrewphilipsmith andrewphilipsmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @RuthBowyer - Looks good! I've added comments to the files, which I've summarised here:

  • There are a couple of suggestions about the text itself. Feel free to use these or ignore them as you feel appropriate.
  • There is a question about the downloads. It is important to know whether or not these are working as intended before we merge this.
  • The linting will need to be fixed. Done

Let me know if there is anything I can do to help.

README.md Outdated
The [UK Climate Projections 2018 (UKCP18)](https://www.metoffice.gov.uk/research/approach/collaboration/ukcp) dataset offers insights into the potential climate changes in the UK. UKCP18 is an advancement of the UKCP09 projections and delivers the latest evaluations of the UK's possible climate alterations in land and marine regions throughout the 21st century. This crucial information aids in future Climate Change Risk Assessments and supports the UK’s adaptation to climate change challenges and opportunities as per the National Adaptation Programme.
We make use of the [Convection Permitting Model (CPM)](https://www.metoffice.gov.uk/pub/data/weather/uk/ukcp18/science-reports/UKCP-Convection-permitting-model-projections-report.pdf). This dataset represents a much finer resolution of climate model (2.2km grid) than typical climate-models, representing a step forward in the ability to simulate small scale behavior (in particular 'atmospheric convection'), and the influence of mountains, coastlines and urban areas. As a result, the CPM provides access to credible climate information important for small-scale weather features and also on local (kilometre) scale; which is particularly important for improving our understanding of climate change in cities.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpicking point - but I would add in the word "spatial", so "much finer resolution" becomes "much finer spatial resolution" (Feel free to ignore).

Suggested change
We make use of the [Convection Permitting Model (CPM)](https://www.metoffice.gov.uk/pub/data/weather/uk/ukcp18/science-reports/UKCP-Convection-permitting-model-projections-report.pdf). This dataset represents a much finer resolution of climate model (2.2km grid) than typical climate-models, representing a step forward in the ability to simulate small scale behavior (in particular 'atmospheric convection'), and the influence of mountains, coastlines and urban areas. As a result, the CPM provides access to credible climate information important for small-scale weather features and also on local (kilometre) scale; which is particularly important for improving our understanding of climate change in cities.
We make use of the [Convection Permitting Model (CPM)](https://www.metoffice.gov.uk/pub/data/weather/uk/ukcp18/science-reports/UKCP-Convection-permitting-model-projections-report.pdf). This dataset represents a much finer spatial resolution of climate model (2.2km grid) than typical climate-models, representing a step forward in the ability to simulate small scale behavior (in particular 'atmospheric convection'), and the influence of mountains, coastlines and urban areas. As a result, the CPM provides access to credible climate information important for small-scale weather features and also on local (kilometre) scale; which is particularly important for improving our understanding of climate change in cities.

README.md Outdated
The [UK Climate Projections 2018 (UKCP18)](https://www.metoffice.gov.uk/research/approach/collaboration/ukcp) dataset offers insights into the potential climate changes in the UK. UKCP18 is an advancement of the UKCP09 projections and delivers the latest evaluations of the UK's possible climate alterations in land and marine regions throughout the 21st century. This crucial information aids in future Climate Change Risk Assessments and supports the UK’s adaptation to climate change challenges and opportunities as per the National Adaptation Programme.
We make use of the [Convection Permitting Model (CPM)](https://www.metoffice.gov.uk/pub/data/weather/uk/ukcp18/science-reports/UKCP-Convection-permitting-model-projections-report.pdf). This dataset represents a much finer resolution of climate model (2.2km grid) than typical climate-models, representing a step forward in the ability to simulate small scale behavior (in particular 'atmospheric convection'), and the influence of mountains, coastlines and urban areas. As a result, the CPM provides access to credible climate information important for small-scale weather features and also on local (kilometre) scale; which is particularly important for improving our understanding of climate change in cities.

The UKCP18-CPM is comprised of 12 ensemble members (or runs). In addition to run 1, we selected the runs which represented the mean, 2nd highest and 2nd lowest daily tasmax values across the whole sequence (runs 5, 6, 7 & 8) to provide users with enough uncertainty in their estimates to appropriately assess bias correction methods.
Copy link
Collaborator

@andrewphilipsmith andrewphilipsmith Nov 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line 65 has a very long sentence which I find hard to follow. A couple of things that aren't clear:

  • Why is run 1 selected?
  • "the mean, 2nd highest and 2nd lowest daily tasmax" -> implies three ensembles, but four are listed "runs 5, 6, 7 & 8".

One suggestion would be to list the run and their reasons as bullet points (below). Alternatively, a table might help here.

Suggested change
The UKCP18-CPM is comprised of 12 ensemble members (or runs). In addition to run 1, we selected the runs which represented the mean, 2nd highest and 2nd lowest daily tasmax values across the whole sequence (runs 5, 6, 7 & 8) to provide users with enough uncertainty in their estimates to appropriately assess bias correction methods.
The UKCP18-CPM is comprised of 12 ensemble members (or runs). We selected a subset of these ensembles for the following reasons:
* `run 1` - Selected because ....
* `run 5` - Has the highest/lowest tasmax ....
* `run 6` - Has the second highest/lowest tasmax ....
* etc....
We believe that this combination will provide users with enough uncertainty in their estimates to assess the bias correction methods appropriately.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd be interested to know why you changed the region names to lowercase? Is this just cosmetic or did it not work otherwise?

  • If it is cosmetic, I'm happy to go with lowercase.
  • If the download commands didn't work with the title case, then we need to check this. It implies there is something wrong - possibly a setting in the Azure storage that we need to double-check.

(All the commands use the grep switches -i and -E. It might be appropriate to add a small note to explain the meaning of these and/or point to existing documentation for these standard tools).

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for flagging this @andrewphilipsmith - also happy to go with lowercase. I've taken a look and both title and lower case versions of the example command seem to function as expected.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah thanks folks - I thought when I tried only the lowercase version worked for some reason! But probably I just had a typo in the actual name or something - I will change back!

README.md Outdated Show resolved Hide resolved
README.md Outdated

However, in order to apply and assess these methods, the climate model of interest needs to be overlaid to corresponding observation data. This can be a time-consuming and laborious process where data is spatially and temporally very granular.

The `clim-recal` pipeline addresses this by providing preprocessed data, including the innovative [UKCP18-CPM datasets](# The Datasets), to facilitate the assessment of these methods on aligned, reprojected data, without requiring the whole (very large) dataset.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the link to the datasets section might need to be specified as:

Suggested change
The `clim-recal` pipeline addresses this by providing preprocessed data, including the innovative [UKCP18-CPM datasets](# The Datasets), to facilitate the assessment of these methods on aligned, reprojected data, without requiring the whole (very large) dataset.
The `clim-recal` pipeline addresses this by providing preprocessed data, including the innovative [UKCP18-CPM datasets](#the-datasets), to facilitate the assessment of these methods on aligned, reprojected data, without requiring the whole (very large) dataset.

README.md Outdated Show resolved Hide resolved
README.md Outdated

# Contributing

If you have suggestions on the repository, or would like to include a new method (see below) or library, please
If you have suggestions on the repository, please:
- raise an [issue](https://github.com/alan-turing-institute/clim-recal/issues)
- [get in touch](mailto:[email protected])
- see our [contributing](docs/contributing.md) section, which includes details on contriubting to the documentation.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- see our [contributing](docs/contributing.md) section, which includes details on contriubting to the documentation.
- see our [contributing](docs/contributing.md) section, which includes details on contributing to the documentation.

@sgreenbury
Copy link
Collaborator

Thanks for this @RuthBowyer, all looks great! I've just added a few small suggestions in the code above.

@RuthBowyer RuthBowyer requested review from andrewphilipsmith and sgreenbury and removed request for sgreenbury December 3, 2024 21:18
Copy link
Collaborator

@andrewphilipsmith andrewphilipsmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@andrewphilipsmith andrewphilipsmith merged commit f00e823 into main Dec 6, 2024
3 checks passed
@andrewphilipsmith andrewphilipsmith deleted the doc_updates branch December 6, 2024 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants