diff --git a/README.rst b/README.rst index bb8cc980c8024674d1d7f35e6a3a2283aec64045..beab8eae559d925591f0fbb88a6d00c41610155d 100644 --- a/README.rst +++ b/README.rst @@ -8,11 +8,20 @@ The toolbox has built-in supports two source of reference sources: 1. Polarstern position and heading 2. MOSAiC floenavi virtual reference station -**Requirements**: +The floenavi toolbox and the underlying `icedrift package <https://gitlab.awi.de/floenavi-crs/icedrift/>`_ are published under a `MIT License <https://gitlab.awi.de/floenavi-crs/floenavi/-/blob/master/LICENSE>`_ and provided "as is" and without warranty of any kind. -Zhe toolbox is based on python 3 and has been tested until python 3.7 version so far. In addition to standard python packages it uses the `icedrift <https://gitlab.awi.de/floenavi-crs/icedrift/>`_ package for the coordinate transformation. +Citation +-------- -**Installation**: +FloeNavi toolbox 1.0.2 (https://gitlab.awi.de/floenavi-crs), Stefan Hendricks, Alfred Wegener Institute Helmholtz Center for Polar and Marine Research (DATE OF LAST ACCESS). + +Requirements +------------ + +The toolbox is based on python 3 and has been tested until python 3.7 version so far. In addition to standard python packages it uses the `icedrift <https://gitlab.awi.de/floenavi-crs/icedrift/>`_ package for the coordinate transformation. + +Installation +------------ The python uses standard python package conventions and can be installed with pip directly from the git repository: @@ -21,7 +30,8 @@ The python uses standard python package conventions and can be installed with pi pip install https://gitlab.awi.de/floenavi-crs/floenavi.git -**Examples**: +Examples +-------- Using the floenavi toolbox with: @@ -29,9 +39,10 @@ Using the floenavi toolbox with: 2. `polarstern reference data <https://gitlab.awi.de/floenavi-crs/floenavi/-/blob/master/examples/mosaic-polarstern-refstat-example.ipynb?expanded=true&viewer=rich>`_ -**Citation**: +Contributing +------------ -FloeNavi toolbox 1.0.2 (https://gitlab.awi.de/floenavi-crs), Stefan Hendricks, Alfred Wegener Institute Helmholtz Center for Polar and Marine Research (DATE OF LAST ACCESS). +Preferred method for reporting any issues is the `issue tracker of this project <https://gitlab.awi.de/floenavi-crs/floenavi/-/issues>`_. Alternatively contact `Stefan Hendricks <mailto:stefan.hendricks@awi.de>`_ via email.