Skip to content

Commit

Permalink
Updated links to GMD paper in the docs (#740)
Browse files Browse the repository at this point in the history
* gmd_changes

* gmd_changes2

* gmd_changes3
  • Loading branch information
matthiasdusch authored and fmaussion committed Apr 8, 2019
1 parent a3a2190 commit 3f37514
Show file tree
Hide file tree
Showing 9 changed files with 57 additions and 53 deletions.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ About

:Citation:
.. image:: https://img.shields.io/badge/Citation-GMD%20paper-orange.svg
:target: https://www.geosci-model-dev-discuss.net/gmd-2018-9/
:target: https://www.geosci-model-dev.net/12/909/2019/
:alt: GMD Paper

.. image:: https://zenodo.org/badge/43965645.svg
Expand Down
48 changes: 25 additions & 23 deletions docs/citing-oggm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,27 @@ Publication
-----------

If you want to refer to OGGM in your publications or presentations, please
refer to the paper in `Geoscientific Model Development`_ (in review).
refer to the paper in `Geoscientific Model Development`_.

BibTeX entry::

@Article{gmd-2018-9,
AUTHOR = {Maussion, F. and Butenko, A. and Eis, J. and Fourteau, K. and
@Article{gmd-12-909-2019,
AUTHOR = {Maussion, F. and Butenko, A. and Champollion, N. and
Dusch, M. and Eis, J. and Fourteau, K. and Gregor, P. and
Jarosch, A. H. and Landmann, J. and Oesterle, F. and
Recinos, B. and Rothenpieler, T. and Vlug, A. and
Wild, C. T. and Marzeion, B.},
TITLE = {The Open Global Glacier Model (OGGM) v1.0},
JOURNAL = {Geoscientific Model Development Discussions},
VOLUME = {2018},
YEAR = {2018},
PAGES = {1--33},
URL = {https://www.geosci-model-dev-discuss.net/gmd-2018-9/},
DOI = {10.5194/gmd-2018-9}
Recinos, B. and Rothenpieler, T. and Vlug, A. and Wild, C. T. and
Marzeion, B.},
TITLE = {The Open Global Glacier Model (OGGM) v1.1},
JOURNAL = {Geoscientific Model Development},
VOLUME = {2019},
YEAR = {2019},
PAGES = {909--931},
URL = {https://www.geosci-model-dev.net/12/909/2019/},
DOI = {10.5194/gmd-12-909-2019}
}


.. _Geoscientific Model Development: https://www.geosci-model-dev-discuss.net/gmd-2018-9/
.. _Geoscientific Model Development: https://www.geosci-model-dev.net/12/909/2019/


Software DOI
Expand All @@ -36,17 +37,18 @@ Software DOI
If you want to refer to a specific version of the software you can use
the `Zenodo citation`_ for this purpose. An example BibTeX entry::

@misc{OGGM_v1.0.0,
@misc{OGGM_v1.1,
author = {Fabien Maussion and Timo Rothenpieler and
Beatriz Recinos and Anouk Vlug and
Ben Marzeion and Felix Oesterle and
Johannes Landmann and Alex Jarosch and
Julia Eis and Anton Butenko and Schmitty Smith},
title = {OGGM/oggm: v1.0.0},
month = jan,
year = 2018,
doi = {10.5281/zenodo.1149701},
url = {https://doi.org/10.5281/zenodo.1149701}
Matthias Dusch and Beatriz Recinos and Anouk Vlug and
Ben Marzeion and Johannes Landmann and Julia Eis and
Sadie Bartholomew and Nicolas Champollion and
Philipp Gregor and Anton Butenko and Schmitty Smith and
Moritz Oberrauch},
title = {OGGM/oggm: v1.1},
month = feb,
year = 2019,
doi = {10.5281/zenodo.2580277},
url = {https://doi.org/10.5281/zenodo.2580277}
}

.. _Zenodo citation: https://zenodo.org/badge/latestdoi/43965645
Expand Down
2 changes: 1 addition & 1 deletion docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ be simulated by flowlines, very cold climates which don't allow melting to
occur, or numerical instabilities during the simulation. Altogether, 4218
glaciers (3.6% of the total area worldwide) could not be modelled by
OGGM in the
`standard global simulations <https://www.geosci-model-dev-discuss.net/gmd-2018-9/>`_.
`standard global simulations <https://www.geosci-model-dev.net/12/909/2019/>`_.
Some regions experience more errors than others (see the paper).

When you experience errors, you have to decide if they are due to an error
Expand Down
48 changes: 25 additions & 23 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Principles
Physical principles implemented in the model and their underlying assumptions,
with as little code as possible. For more detailed information, we recommend
to read the OGGM
`description paper <https://www.geosci-model-dev-discuss.net/gmd-2018-9/>`_ as
`description paper <https://www.geosci-model-dev.net/12/909/2019/>`_ as
well.

* :doc:`introduction`
Expand Down Expand Up @@ -123,22 +123,23 @@ copy or modify its code at your wish, under certain conditions:
1. When using this software, please acknowledge the original authors of this
contribution by linking to our project website `www.oggm.org <http://oggm.org>`_.
For your publications, presentations or posters we kindly ask you to refer to the
`paper in Geoscientific Model Development`_ (in review).
`paper in Geoscientific Model Development`_.

BibTeX entry::

@Article{gmd-2018-9,
AUTHOR = {Maussion, F. and Butenko, A. and Eis, J. and Fourteau, K. and
@Article{gmd-12-909-2019,
AUTHOR = {Maussion, F. and Butenko, A. and Champollion, N. and
Dusch, M. and Eis, J. and Fourteau, K. and Gregor, P. and
Jarosch, A. H. and Landmann, J. and Oesterle, F. and
Recinos, B. and Rothenpieler, T. and Vlug, A. and
Wild, C. T. and Marzeion, B.},
TITLE = {The Open Global Glacier Model (OGGM) v1.0},
JOURNAL = {Geoscientific Model Development Discussions},
VOLUME = {2018},
YEAR = {2018},
PAGES = {1--33},
URL = {https://www.geosci-model-dev-discuss.net/gmd-2018-9/},
DOI = {10.5194/gmd-2018-9}
TITLE = {The Open Global Glacier Model (OGGM) v1.1},
JOURNAL = {Geoscientific Model Development},
VOLUME = {2019},
YEAR = {2019},
PAGES = {909--931},
URL = {https://www.geosci-model-dev.net/12/909/2019/},
DOI = {10.5194/gmd-12-909-2019}
}


Expand All @@ -147,17 +148,18 @@ copy or modify its code at your wish, under certain conditions:

An example BibTeX entry::

@misc{OGGM_v1.0.0,
@misc{OGGM_v1.1,
author = {Fabien Maussion and Timo Rothenpieler and
Beatriz Recinos and Anouk Vlug and
Ben Marzeion and Felix Oesterle and
Johannes Landmann and Alex Jarosch and
Julia Eis and Anton Butenko and Schmitty Smith},
title = {OGGM/oggm: v1.0.0},
month = jan,
year = 2018,
doi = {10.5281/zenodo.1149701},
url = {https://doi.org/10.5281/zenodo.1149701}
Matthias Dusch and Beatriz Recinos and Anouk Vlug and
Ben Marzeion and Johannes Landmann and Julia Eis and
Sadie Bartholomew and Nicolas Champollion and
Philipp Gregor and Anton Butenko and Schmitty Smith and
Moritz Oberrauch},
title = {OGGM/oggm: v1.1},
month = feb,
year = 2019,
doi = {10.5281/zenodo.2580277},
url = {https://doi.org/10.5281/zenodo.2580277}
}


Expand All @@ -169,7 +171,7 @@ copy or modify its code at your wish, under certain conditions:
See the `wikipedia page about GPL`_ and the `OGGM license`_ for more
information.

.. _paper in Geoscientific Model Development: https://www.geosci-model-dev-discuss.net/gmd-2018-9/
.. _paper in Geoscientific Model Development: https://www.www.geosci-model-dev.net/12/909/2019/

.. _Zenodo citation: https://zenodo.org/badge/latestdoi/43965645

Expand All @@ -191,7 +193,7 @@ About

:Citation:
.. image:: https://img.shields.io/badge/Citation-GMD%20paper-orange.svg
:target: https://www.geosci-model-dev-discuss.net/gmd-2018-9/
:target: https://www.www.geosci-model-dev.net/12/909/2019/
:alt: GMD Paper

.. image:: https://zenodo.org/badge/43965645.svg
Expand Down
2 changes: 1 addition & 1 deletion docs/input-data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -445,4 +445,4 @@ have access to the timeseries through the glacier directory:
.. _WGMS: https://wgms.ch
.. _Fluctuations of Glaciers (FoG): https://wgms.ch/data_databaseversions/
.. _GMD Paper: https://www.geosci-model-dev-discuss.net/gmd-2018-9/
.. _GMD Paper: https://www.geosci-model-dev.net/12/909/2019/
2 changes: 1 addition & 1 deletion docs/inversion.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ there is no "optimum" :math:`f_{inv}` parameter in the model. There is a high
uncertainty in the "true" :math:`A` parameter as well as in all other processes
affecting the ice thickness. Therefore, we cannot make any recommendation for
the "best" parameter. Global sensitivity analyses show that the default value
is a good compromise (`Maussion et al., 2018 <https://www.geosci-model-dev-discuss.net/gmd-2018-9/>`_)
is a good compromise (`Maussion et al., 2018 <https://www.geosci-model-dev.net/12/909/2019/>`_)

*Note*: for `ITMIX <https://www.the-cryosphere.net/11/949/2017/>`_, :math:`f_{inv}`
was set to a value of approximately 3 (which was too high and underestimated
Expand Down
2 changes: 1 addition & 1 deletion docs/run_examples/run_errors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
===================

OGGM will not be able to run on a number of glaciers. We summarized the reasons
for this in `our GMD publication <https://www.geosci-model-dev-discuss.net/gmd-2018-9/>`_
for this in `our GMD publication <https://www.geosci-model-dev.net/12/909/2019/>`_
and showed that the number of failing glaciers can be quite high depending
on the region considered.

Expand Down
2 changes: 1 addition & 1 deletion docs/run_examples/run_inversion.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ parameter.

There is currently no "best" set of parameters for the ice thickness
inversion model. As shown in
`Maussion et al. (2018) <https://www.geosci-model-dev-discuss.net/gmd-2018-9/>`_,
`Maussion et al. (2019) <https://www.geosci-model-dev.net/12/909/2019/>`_,
the default parameter set results in global volume estimates which are a bit
larger than previous values. For the consensus estimate of
`Farinotti et al. (2018) <https://www.nature.com/articles/s41561-019-0300-3>`_,
Expand Down
2 changes: 1 addition & 1 deletion docs/whats-new.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ v1.1 (28.02.2019)
This is a major new release of the OGGM model, with substantial improvements
to version 1. We recommend to use this version from now on. It coincides
with the publication of our publication in
`Geoscientific Model Development <https://www.geosci-model-dev-discuss.net/gmd-2018-9/>`_.
`Geoscientific Model Development <https://www.geosci-model-dev.net/12/909/2019/>`_.

New contributors to the project:

Expand Down

0 comments on commit 3f37514

Please sign in to comment.