Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
updated README to show the same start as the readthedocs
  • Loading branch information
ClimateClara committed Oct 15, 2020
1 parent 428e1dc commit acb2e88
Showing 1 changed file with 23 additions and 8 deletions.
31 changes: 23 additions & 8 deletions README.rst
Expand Up @@ -15,17 +15,32 @@ ARC3O

.. end-badges
This is the code for the Arctic Observation Operator for 6.9 GHz, presented in:
.. arc3o documentation master file, created by
sphinx-quickstart on Mon Aug 10 11:47:09 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Burgard, C., Notz, D., Pedersen, L. T., and Tonboe, R. T.: The Arctic Ocean Observation Operator for 6.9 GHz (ARC3O) – Part 2: Development and evaluation, The Cryosphere, 14, 2387–2407, https://doi.org/10.5194/tc-14-2387-2020, 2020.
Welcome to the documentation about the Arctic Observation Operator!
===================================================================

**! Please be careful when using the code !**
The Arctic Ocean Observation Operator (ARC3O) computes brightness temperatures at 6.9 GHz,
vertical polarization, based on climate model output. More information about the motivation,
structure and evaluation can be found in `Burgard et al., 2020a`_ and `Burgard et al., 2020b`_.

Especially, there might not be an error message when ran at another polarization or frequency than 6.9 GHz, vertical polarization,
but the results have only be evaluated at that frequency and polarization!
Currently, it is customized for output of the Max Planck Institute Earth System Model but can be
used for other models if the variable names are changed accordingly in the ARC3O functions.

If you are interested in 6.9 GHz, vertical polarization, enjoy! :)
You can access the detailed documentation here: https://arc3o.readthedocs.io/

How to cite ARC3O
-----------------

The detailed description and evaluation of ARC3O is found in `Burgard et al., 2020b`_ and should
therefore, when used, be cited as follows:

Burgard, C., Notz, D., Pedersen, L. T., and Tonboe, R. T. (2020): "The Arctic Ocean Observation Operator for 6.9 GHz (ARC3O) – Part 2: Development and evaluation", *The Cryosphere*, 14, 2387–2407, https://doi.org/10.5194/tc-14-2387-2020.

.. _`Burgard et al., 2020a`: https://tc.copernicus.org/articles/14/2369/2020/
.. _`Burgard et al., 2020b`: https://tc.copernicus.org/articles/14/2387/2020/

To read more about ARC3O and know how to run it, check out the documentation here: https://arc3o.readthedocs.io/

Contact me at clara.burgard@gmail.com in case of questions.

0 comments on commit acb2e88

Please sign in to comment.