Skip to content

Commit 61d44a1

Browse files
committed
Add missing references to bedmachine
1 parent d437365 commit 61d44a1

File tree

2 files changed

+13
-10
lines changed

2 files changed

+13
-10
lines changed

docs/geometric_data.rst

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,22 @@ Geometric Data
55

66
The the overarching purpose of ``geometric_features`` is to facilitate access
77
to and manipulation of the geometric data in the repository. This data is
8-
currently divided across 5 components, ``bedmap2``, ``iceshelves``,
9-
``landice``, ``natural_earth``, and ``ocean``.
8+
currently divided across 6 components, ``bedmachine``, ``bedmap2``,
9+
``iceshelves``, ``landice``, ``natural_earth``, and ``ocean``.
1010

1111
Components
1212
----------
1313

14-
bedmap2
15-
^^^^^^^
14+
bedmachine and bedmap2
15+
^^^^^^^^^^^^^^^^^^^^^^
1616

17-
This component defines two "coastlines" between the Antarctic continent and
18-
the ocean. One exclues the cavity under ice shelves while the other includes
19-
them. The dataset used to define these coastlines is Bedmap2
20-
(`Fretwell et al. 2016`_).
17+
These components each define two "coastlines" between the Antarctic continent
18+
and the ocean. One excludes the cavity under ice shelves while the other
19+
includes them. The ``bedmachine`` component uses the BedMachine Antarctica
20+
dataset
21+
(`Morlighem et al. 2020 <https://www.nature.com/articles/s41561-019-0510-8>`_)
22+
to define the coastlines, while the ``bedmap2`` dataset is based on Bedmap2
23+
(`Fretwell et al. 2016 <http://www.the-cryosphere.net/7/375/2013/>`_).
2124

2225
iceshelves
2326
^^^^^^^^^^
@@ -176,7 +179,7 @@ Here are two simple examples of features from the repository:
176179
]
177180
}
178181
179-
.. _`Fretwell et al. 2016`: http://www.the-cryosphere.net/7/375/2013/
182+
180183
.. _`IMBIE1 Basins`: http://imbie.org/imbie-2016/drainage-basins/
181184
.. _`Natural Earth`: http://www.naturalearthdata.com/
182185
.. _`International Hydrographic Organisation`: http://www.marineregions.org/downloads.php#iho

geometric_features/test/test_set_group_name.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ def test_assign_groupname(self, componentName='ocean', objectType='region',
2222
2323
Parameters
2424
----------
25-
componentName : {'bedmap2', 'iceshelves', 'landice', 'natural_earth', 'ocean'}, optional
25+
componentName : {'bedmachine', 'bedmap2', 'iceshelves', 'landice', 'natural_earth', 'ocean'}, optional
2626
The component from which to retieve the feature
2727
2828
objectType : {'point', 'transect', 'region'}, optional

0 commit comments

Comments
 (0)