From 9e513d5cbfc8ab8baca7f7411de849c2fadfab64 Mon Sep 17 00:00:00 2001 From: nperez Date: Tue, 17 May 2022 13:35:58 +0200 Subject: [PATCH 1/3] Readme update --- README.md | 46 +++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 43 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index caf76cab..4ff0d7cc 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,42 @@ -Welcome to the MEDSCOPE GitLab website +Welcome to the CSTools GitLab website ====================================== -This website graphically displays the MEDSCOPE Git project. It allows you to monitor its progress and to interact with other developers via the Issues section. +The Climate Services Tools, CSTools, is an easy-to-use R package designed and built to assess and improve the quality of climate forecasts for seasonal to multi–annual scales. The package contains process-based state-of-the-art methods for forecast calibration, bias correction, statistical and stochastic downscaling, optimal forecast combination and multivariate verification, as well as basic and advanced tools to obtain tailored products. +This package was developed in the context of the ERA4CS project MEDSCOPE and the H2020 S2S4E project. This GitLab project allows you to monitor its progress and to interact with other developers via the Issues section. + +A scientific publication including use cases is under-review in the Geoscientific Model Development Journal and it can be cited as follows: + +> Pérez-Zanón, N., Caron, L.-P., Terzago, S., Van Schaeybroeck, B., Lledó, L., Manubens, N., Roulin, E., Alvarez-Castro, M. C., Batté, L., Delgado-Torres, C., Domínguez, M., von Hardenberg, J., Sánchez-García, E., Torralba, V., and Verfaillie, D.: The CSTools (v4.0) Toolbox: from Climate Forecasts to Climate Forecast Information, Geosci. Model Dev. Discuss. [preprint], https://doi.org/10.5194/gmd-2021-368, in review, 2021. + +On-line resources +----------------- + +A part from this GitLab project allows you to monitor its progress and to interact with other developers via the Issues section and to contribute, you can find: + +- The CRAN repository which includes the user manual and vignettes + +- Video tutorials + +- Other resources are under-development such [training material](https://earth.bsc.es/gitlab/external/cstools/-/tree/MEDCOF2022/inst/doc/MEDCOF2022) and a [full reproducible use case for forecast calibration](https://earth.bsc.es/gitlab/external/cstools/-/tree/develop-CalibrationVignette/FOCUS_7_2) + +Installation +------------ + +CSTools has a system dependency, the CDO libraries, for interpolation of grid data +and retrieval of metadata. Make sure you have these libraries installed in the +system or download and install from +. + +You can then install the public released version of CSTools from CRAN: +```r +install.packages("CSTools") +``` +Or the development version from the GitLab repository: +```r +# install.packages("devtools") +devtools::install_git("https://earth.bsc.es/gitlab/external/cstools.git") +``` While it provides some very basic tools to add and modify files in the Git project, if you plan on contributing, you should rather clone the project on your workstation and modify it using the basic Git commands (clone, branch, add, commit, push, merge, ...). The source code of the MEDSCOPE prototype will be structured as an R package. The code of each function should live in a separate file with the .R extension under the R folder, and the documentation of each function should live in a separate file with the .Rd extension under the man folder. @@ -11,4 +45,10 @@ For an introductory video on Git, you can have a look at https://vimeo.com/41027 You can also find all the necessary documentation on git here: https://git-scm.com/book/en/v2 A lot of it may be a bit complicated for beginners (and not necessary for us), but the "Getting started" and "Git basics" sections are a good resources. -And you can find supporting videos here: https://vimeo.com/41027679. \ No newline at end of file +And you can find supporting videos here: https://vimeo.com/41027679. + +How to contribute +----------------- + +Before adding a development, we suggest to contact the package mantainer. Details on the procedure and development guidelines can be found in [this issue](https://earth.bsc.es/gitlab/external/cstools/-/issues/3) + -- GitLab From cdad47558ef515735616cbd360cccdf3da3b3635 Mon Sep 17 00:00:00 2001 From: nperez Date: Tue, 17 May 2022 14:50:43 +0200 Subject: [PATCH 2/3] Info reordered --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 4ff0d7cc..80e004e6 100644 --- a/README.md +++ b/README.md @@ -37,18 +37,18 @@ Or the development version from the GitLab repository: # install.packages("devtools") devtools::install_git("https://earth.bsc.es/gitlab/external/cstools.git") ``` -While it provides some very basic tools to add and modify files in the Git project, if you plan on contributing, you should rather clone the project on your workstation and modify it using the basic Git commands (clone, branch, add, commit, push, merge, ...). - -The source code of the MEDSCOPE prototype will be structured as an R package. The code of each function should live in a separate file with the .R extension under the R folder, and the documentation of each function should live in a separate file with the .Rd extension under the man folder. - -For an introductory video on Git, you can have a look at https://vimeo.com/41027679. - -You can also find all the necessary documentation on git here: https://git-scm.com/book/en/v2 -A lot of it may be a bit complicated for beginners (and not necessary for us), but the "Getting started" and "Git basics" sections are a good resources. -And you can find supporting videos here: https://vimeo.com/41027679. How to contribute ----------------- Before adding a development, we suggest to contact the package mantainer. Details on the procedure and development guidelines can be found in [this issue](https://earth.bsc.es/gitlab/external/cstools/-/issues/3) +If you plan on contributing, you should rather clone the project on your workstation and modify it using the basic Git commands (clone, branch, add, commit, push, merge, ...). + +The code of each function should live in a separate file with the .R extension under the R folder, and the documentation of each function should live in a separate file with the .Rd extension under the man folder. + +For an introductory video on Git, you can have a look at https://vimeo.com/41027679. + +You can also find all the necessary documentation on git here: https://git-scm.com/book/en/v2 +A lot of it may be a bit complicated for beginners (and not necessary for us), but the "Getting started" and "Git basics" sections are a good resources. + -- GitLab From 3cf7d2b4a1ab64b4def755584b166008d5564ecf Mon Sep 17 00:00:00 2001 From: nperez Date: Tue, 17 May 2022 14:52:39 +0200 Subject: [PATCH 3/3] Typos --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 80e004e6..40bc01ba 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ A scientific publication including use cases is under-review in the Geoscientifi On-line resources ----------------- -A part from this GitLab project allows you to monitor its progress and to interact with other developers via the Issues section and to contribute, you can find: +A part from this GitLab project, that allows you to monitor CSTools progress, to interact with other developers via the Issues section and to contribute, you can find: - The CRAN repository which includes the user manual and vignettes -- GitLab