From 8168e7a84fc8f8839035d0ea00cdd7a7d32e9b84 Mon Sep 17 00:00:00 2001 From: Pao Corrales Date: Wed, 14 Feb 2024 13:07:55 -0300 Subject: [PATCH] General revision of structure --- _quarto.yml | 2 +- about.qmd | 12 ++++++------ contribute.qmd | 11 +++++------ index.qmd | 12 ++++-------- 4 files changed, 16 insertions(+), 21 deletions(-) diff --git a/_quarto.yml b/_quarto.yml index e6c80ef..d602ed0 100644 --- a/_quarto.yml +++ b/_quarto.yml @@ -3,7 +3,7 @@ project: output-dir: _site website: - title: "DA-documentation" + title: "Data Assimilation docs" repo-url: https://github.com/paocorrales/DA-documentation issue-url: https://github.com/paocorrales/DA-documentation/issues/new/choose repo-actions: [edit, issue] diff --git a/about.qmd b/about.qmd index 7972bee..eca9f2e 100644 --- a/about.qmd +++ b/about.qmd @@ -2,14 +2,14 @@ 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. +## Hi! -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. +I'm Pao Corrales and I have a PhD in Atmospheric Science! The main goal of my research was to applied data assimilation techniques to improve short-term forecasts of severe events in Argentina. In particular, the research focuses on data assimilation of observations from automatic stations and radiances from polar and geostationary satellites. You can read the final dissertation (in Spanish) [here](https://paocorrales.github.io/Tesis_doctorado/). -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. +I worked in the [Centro de Investigaciones del Mar y la Atmósfera](https://www.cima.fcen.uba.ar/index.php) (CIMA), for that reason you may find mentions to Hydra or Yakaira, their HPC and a server I used a lot. -## About my PhD +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. -The main goal of may research was to applied data assimilation techniques to improve short-term forecasts of severe events in Argentina. In particular, the research focuses on data assimilation of observations from automatic stations and radiances from polar and geostationary satellites. You can read the final dissertation (in Spanish) [here](https://paocorrales.github.io/Tesis_doctorado/). +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](contribute.qmd) of this website and contribute to make this guide better. -I worked in the [Centro de Investigaciones del Mar y la Atmósfera](https://www.cima.fcen.uba.ar/index.php) (CIMA), for that reason you may find mentions to Hydra or Yakaira, their HPC and a server I used a lot. +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 index 24af07b..fa182dd 100644 --- a/contribute.qmd +++ b/contribute.qmd @@ -2,21 +2,20 @@ title: "How to contribute" --- -This outlines how to propose a change to DA-documentation. +This outlines how to propose a change to this website. ## 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 +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 in the repo. ## Bigger changes -If you want to make a bigger change, it's a good idea to first file an issue to start a conversation. +If you want to make a bigger change, it's a good idea to first open 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. +To open a pull request you'll need to fork the repository. This website is built 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). - +If you contribute to this guide, I'd like to publicly acknowledge your work. Please indicate in you PR if you want to be add to the [Contributors page](contributors.qmd). diff --git a/index.qmd b/index.qmd index b8bf090..2354f41 100644 --- a/index.qmd +++ b/index.qmd @@ -1,14 +1,10 @@ -::: {.callout-important} -## This is a work in progress +# Welcome! -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. +This website compiles a series of examples, 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 EnKF version. It covers everything you need to know from how to deal with observations (in bufr format), how to configure the system to assimilate conventional and radiance observtions to how to 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. +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 note associated to each section and cite it appropriately. ## Citing this guide @@ -16,4 +12,4 @@ 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 +Any contribution is welcome, please read [this guide](contribute.qmd) to learn how to do it.