diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..f898edc --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,19 @@ +# Contributing to DA-documentation + +This outlines how to propose a change to DA-documentation. + +## Fixing typos + +You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the *source* file. This will automatically open a pull request + +## Bigger changes + +If you want to make a bigger change, it's a good idea to first file an issue to start a conversation. + +### Pull request process + +To open a pull request you'll need to fork the repository. This website is builded with quarto, make sure you have it installed if you want to build the website locally to test the chances you are proposing. + +## Acknowledgements + +If you contribute to this guide, I'd like to publicly acknowledge you work. Please indicate in you PR if you want to be add to the Contributors page. diff --git a/about.qmd b/about.qmd new file mode 100644 index 0000000..5165a8e --- /dev/null +++ b/about.qmd @@ -0,0 +1,9 @@ +--- +title: "About" +--- + +This guide is a compilation of many tools scripts, pieces of code and routines that I used during my PhD. As the name says, everything goes around assimilating observations using the GSI system. I spent a lot of time working with the conventional and Radiance observations so you will find a comprehensive tutorial and documentation on how to assimilate these types of observations. This includes the processing of the observations, how to configure the system and all the quality control steps GSI performs during the assimilation process. + +Sometimes you will find everything inside the website and sometimes you will need to go to a specific repository to get the code or the data associated with the the specific topic. And while I tried to be mindful during my PhD at commenting and documenting everything along the way I'm sure that there are gaps and missing pieces. If you find anything that can be improved please open an issue in the repository of this website and contribute to making this guide better. + +Many of these tools come from different sources. Sometimes someone else wrote the code and I adapted it to my specific needs, sometimes I wrote the code from scratch. So it's important to read the license note in each section so you know who created that code and in which way you can use it. diff --git a/contribute.qmd b/contribute.qmd new file mode 100644 index 0000000..24af07b --- /dev/null +++ b/contribute.qmd @@ -0,0 +1,22 @@ +--- +title: "How to contribute" +--- + +This outlines how to propose a change to DA-documentation. + +## Fixing typos + +You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the source file. This will automatically open a pull request + +## Bigger changes + +If you want to make a bigger change, it's a good idea to first file an issue to start a conversation. + +## Pull request process + +To open a pull request you'll need to fork the repository. This website is builded with quarto, make sure you have it installed if you want to build the website locally to test the chances you are proposing. + +## Acknowledgements + +If you contribute to this guide, I'd like to publicly acknowledge you work. Please indicate in you PR if you want to be add to the [Contributors page](contributors.qmd). + diff --git a/contributors.qmd b/contributors.qmd new file mode 100644 index 0000000..74d701b --- /dev/null +++ b/contributors.qmd @@ -0,0 +1,5 @@ +--- +title: "Contributors" +--- + +Contributors to this guide will appear here. diff --git a/index.qmd b/index.qmd new file mode 100644 index 0000000..b8bf090 --- /dev/null +++ b/index.qmd @@ -0,0 +1,19 @@ +::: {.callout-important} +## This is a work in progress + +Comeback later to see more or, if you want to contribute, open an issue in the associated repo. +::: + +This website compiles a series of tutorials, scripts and in general a comprehensive documentation around the [GSI system V3.7 - EnKF V1.3](https://dtcenter.org/community-code/gridpoint-statistical-interpolation-gsi). It focus on the use of GSI as a observation operator along with the LETKF version. It covers everything you need from how to deal with observations (in bufr format), how to configure the system to how read and interpret GSI outputs. + +## A note about using this material + +While the text in this guide is released under a [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/), specific scripts or programming routines may have different licences and authors. If you use the material in any way, make sure to check the Licence note associated to each section and cite it appropriately. + +## Citing this guide + +You can cite this guide using its Zenodo metadata and DOI . + +## Do you want to contribute? + +Any contribution is welcome, please read [this guide](contribute.qmd) to learn how to do it. \ No newline at end of file diff --git a/license.qmd b/license.qmd new file mode 100644 index 0000000..204033a --- /dev/null +++ b/license.qmd @@ -0,0 +1,5 @@ +--- +title: "Licence" +--- + +The text in this guide is released under a [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/). Specific scripts or programming routines may have different licences and authors. If you use the material in any way, make sure to check the Licence note associated to each section and cite it appropriately.