From 670d7f108b981623aad0f38599cff806952ce3d5 Mon Sep 17 00:00:00 2001 From: Dr Griffith Rees Date: Fri, 5 Jul 2024 17:28:07 +0100 Subject: [PATCH 1/2] feat(doc): add `docs/datasets.qmd` page --- README.md | 4 ++++ _quarto.yml | 3 +++ docs/datasets.qmd | 7 +++++++ 3 files changed, 14 insertions(+) create mode 100644 docs/datasets.qmd diff --git a/README.md b/README.md index 409dadcf..d5b30e07 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,10 @@ Welcome to `clim-recal`, a specialized resource designed to tackle systematic er - Was developed in partnership with the MetOffice to ensure the propriety, quality, and usability of our work - Provides a framework for open additions of new software libraries/bias correction methods (in planning) +## Data results and documentation updates + +*WARNING*: The documentation below is out of date in some cases, and we are in the process of updating this. In the meantime, see our [Exported Datasets](/docs/datasets.qmd) page for updates on datasets released for three UK cities. + ## Table of Contents 1. [Overview: Bias Correction Pipeline](#overview-bias-correction-pipeline) diff --git a/_quarto.yml b/_quarto.yml index e6101d42..7aa9cea2 100644 --- a/_quarto.yml +++ b/_quarto.yml @@ -15,6 +15,7 @@ project: - "docs/reference" - "docs/pipeline.qmd" - "docs/contributing.md" + - "docs/datasets.qmd" - "docs/pipeline_guidance.qmd" - "docs/docker-configurations.qmd" - "python/README.md" @@ -40,6 +41,8 @@ website: href: "README.md" - text: "Install" href: "setup-instructions.md" + - text: "Exported Datasets" + href: "docs/datasets.qmd" - section: "Pipeline" contents: - text: "Guidance" diff --git a/docs/datasets.qmd b/docs/datasets.qmd new file mode 100644 index 00000000..175ce7cf --- /dev/null +++ b/docs/datasets.qmd @@ -0,0 +1,7 @@ +--- +title: Exported Datasets +--- +Thanks for your interest in the `clim-recal` data and metrics. We plan to release a set of combined observation and simulation datasets for three cities in the UK and invite authors of bias correction methods to benchmark their methods for those cities. + +We are still completing this work. As soon as the data are ready for publication, we will update this page with information on how to access them - check back soon. +In the meantime, please check [our blog article](https://urban-analytics-technology-platform.github.io/blog/platform_v2_release/) describing this work. From 44b958cfef8c0611efe31d5c2d42e5ed32d62529 Mon Sep 17 00:00:00 2001 From: griff-rees <60181741+griff-rees@users.noreply.github.com> Date: Mon, 8 Jul 2024 15:21:17 +0100 Subject: [PATCH 2/2] fix: Add better link to blog post in `docs/datasets.qmd` Co-authored-by: Sam Greenbury <50113363+sgreenbury@users.noreply.github.com> --- docs/datasets.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/datasets.qmd b/docs/datasets.qmd index 175ce7cf..0b27240d 100644 --- a/docs/datasets.qmd +++ b/docs/datasets.qmd @@ -4,4 +4,4 @@ title: Exported Datasets Thanks for your interest in the `clim-recal` data and metrics. We plan to release a set of combined observation and simulation datasets for three cities in the UK and invite authors of bias correction methods to benchmark their methods for those cities. We are still completing this work. As soon as the data are ready for publication, we will update this page with information on how to access them - check back soon. -In the meantime, please check [our blog article](https://urban-analytics-technology-platform.github.io/blog/platform_v2_release/) describing this work. +In the meantime, please check [our blog article](https://urban-analytics-technology-platform.github.io/blog/platform_v2_release#clim-recal-a-climate-bias-correction-dataset-for-three-cities) describing this work.