Skip to content

Commit

Permalink
Update docs with link to JOSS paper.
Browse files Browse the repository at this point in the history
  • Loading branch information
simonrp84 authored Mar 27, 2024
1 parent 903ed09 commit f39c37f
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ ____________________________________________________________
`Cox-Munk method <https://doi.org/10.5194/amt-3-813-2010>`_. It is designed for use in areas of open water and may
not provide accurate results in coastal regions, for rivers or for lakes. `pycoxmunk` is designed to be flexible,
supporting a wide range of satellite sensors and allowing the inclusion of surface wind speeds to simulate the effects
of white caps and other wind related wave effects
of white caps and other wind related wave effects.

A spectral database of water properties is included, allowing
`pycoxmunk` to operate across the visible and near-infrared spectrum from approx. 450 to 3700nm. For wavelengths in the
Expand All @@ -34,7 +34,8 @@ reports via the issues tab on the GitHub page.

New users should refer to the `quickstart <./quickstart.html>`_ documentation, while more advanced users can refer to the
`API documentation <./pcm_api.html>`_ and the `technical description <./pcm_technical.html>`_ of the correction method
used in SMACPy.
used in SMACPy. A description of the algorithm and library are also given in
`this <https://joss.theoj.org/papers/10.21105/joss.05074.pdf>`_ paper published in the Journal of Open Source Software.

An example of _pycoxmunk_'s capabilities is shown below. This image shows
`Meteosat Second Generation (MSG) / SEVIRI data <https://data.eumetsat.int/data/map/EO:EUM:DAT:MSG:HRSEVIRI>`_ over land
Expand Down Expand Up @@ -64,4 +65,4 @@ Indices and tables

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
* :ref:`search`

0 comments on commit f39c37f

Please sign in to comment.