Skip to content

Commit b9837d7

Browse files
milenavenezianimilenaveneziani
committed
Adds RIO documentation and RIV entry in obs
1 parent a7c25c6 commit b9837d7

File tree

8 files changed

+232
-4
lines changed

8 files changed

+232
-4
lines changed

‎docs/developers_guide/api.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,7 @@ Sea ice tasks
138138
ClimatologyMapSeaIceVolumeTendencyTransp
139139
TimeSeriesSeaIce
140140
ClimatologyMapIcebergConc
141+
ClimatologyMapRiskIndexOutcome
141142

142143

143144
Shared modules

‎docs/users_guide/analysis_tasks.rst‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,3 +76,6 @@ Analysis Tasks
7676
tasks/timeSeriesSeaIceAreaVol
7777

7878
tasks/climatologyMapIcebergConcSH
79+
80+
tasks/climatologyMapRiskIndexOutcomeNH
81+
tasks/climatologyMapRiskIndexOutcomeSH

‎docs/users_guide/tasks/climatologyMapRiskIndexOutcomeNH.rst‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
.. _task_climatologyMapRiskIndexOutcomeNH:
2+
3+
climatologyMapRiskIndexOutcomeNH
4+
=======================================
5+
6+
An analysis task for plotting maps of Arctic risk index outcome (rio) for navigation in ice-covered waters.
7+
8+
Component and Tags::
9+
10+
component: seaIce
11+
tags: climatology, horizontalMap, RiskIndexOutcome
12+
13+
Configuration Options
14+
---------------------
15+
16+
The following configuration options are available for this task::
17+
18+
[climatologyMapRiskIndexOutcomeNH]
19+
## options related to plotting maps of the Risk Index Outcome (RIO) for navigability
20+
## in sea-ice covered water from climatologies. The Risk Index Outcome is a navigability
21+
## metric defined by the International Maritime Organization (IMO). The index ranges
22+
## from -80 to 30. It depends on the sea-ice concentration and on Risk Index Values,
23+
## which are assigned to a vessel according to its structural properties and according
24+
## to ice thickness (and age). The maximum RIO refers to navigation in open water.
25+
## Navigation under conditions of negative RIO values is restricted to some types
26+
## of vessels. Navigation should generally be avoided where RIO < -10.
27+
28+
# table of Risk Index Values (IMO, MSC.1/Circ.1519 6 June 2016)
29+
# https://www.imorules.com/GUID-2C1D86CB-5D58-490F-B4D4-46C057E1D102.html
30+
rivNH = RIV/riv_MSC.1_Circ.1519_6_June_2016.csv
31+
32+
# colormap for model/observations
33+
colormapNameResult = RdYlBu
34+
# whether the colormap is indexed or continuous
35+
colormapTypeResult = indexed
36+
# color indices into colormapName for filled contours
37+
colormapIndicesResult = [0, 56, 85, 170, 198, 227, 241, 248, 255, 255]
38+
# colormap levels/values for contour boundaries
39+
colorbarLevelsResult = numpy.linspace(-10., 30., 9)
40+
41+
# Months or seasons to plot (Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct,
42+
# Nov, Dec, JFM, AMJ, JAS, OND, ANN)
43+
seasons = ['AMJ', 'OND']
44+
45+
# comparison grid(s) on which to plot analysis
46+
comparisonGrids = ['arctic']
47+
48+
# Polar Class of vessels, according to IMO, for which RIO maps will be generated.
49+
# Range is 1 to 12. Here the values 1-7 refer to the ‘Polar Classes’ PC1-PC7,
50+
# assigned by the International Association of Classification Societies (IACS).
51+
# A PC1 vessel is capable of year-round operations in all polar waters. PC2 and PC3
52+
# vessels can navigate in 2.5 m (or more) thick ice. The values 8-11 correspond
53+
# to the Finnish-Swedish ice classes 'IA Super', 'IA', 'IB' and 'IC'.
54+
# The last value, 12, refers to ‘Not-Ice-Strengthened’ ships, all vessels without
55+
# a Polar Class.
56+
polarClass = 6
57+
58+
# reference floe thicknesses (m) for calculation of the Risk Index Value (RIV)
59+
# The thicknesses are intended to render the type of ice as defined by IMO.
60+
# There must be as many values as there are types of ice in the RIV table.
61+
# The first value has to be zero.
62+
h_to_typeofice = [0, 0.005, 0.1, 0.15, 0.3, 0.5, 0.7, 1, 1.2, 1.7, 2, 2.5]
63+
64+
# whether to use sea-ice categories for sea-ice concentration and thickness
65+
useIceCategories = False
66+
67+
# minimum lat and reference lon for sea ice plots in the northern hemisphere
68+
minimumLatitude = 50
69+
referenceLongitude = 0
70+
71+
# arrange subplots vertically?
72+
vertical = False
73+
74+
The option ``vertical = True`` can be used to plot 3 panels one above another
75+
(resulting in a tall, thin image) rather than next to each other, the default
76+
(resulting in a short, wide image).
77+
78+
For details on the remaining configuration options, see:
79+
* :ref:`config_colormaps`
80+
* :ref:`config_seasons`
81+
* :ref:`config_comparison_grids`
82+
83+
Example Result
84+
--------------
85+
86+
.. image:: examples/risk_index_outcome_nh.png
87+
:width: 720 px
88+
:align: center

‎docs/users_guide/tasks/climatologyMapRiskIndexOutcomeSH.rst‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
.. _task_climatologyMapRiskIndexOutcomeSH:
2+
3+
climatologyMapRiskIndexOutcomeSH
4+
=======================================
5+
6+
An analysis task for plotting maps of Antarctic risk index outcome (rio) for navigation in ice-covered waters.
7+
8+
Component and Tags::
9+
10+
component: seaIce
11+
tags: climatology, horizontalMap, RiskIndexOutcome
12+
13+
Configuration Options
14+
---------------------
15+
16+
The following configuration options are available for this task::
17+
18+
[climatologyMapRiskIndexOutcomeSH]
19+
## options related to plotting maps of the Risk Index Outcome (RIO) for navigability
20+
## in sea-ice covered water from climatologies. The Risk Index Outcome is a navigability
21+
## metric defined by the International Maritime Organization (IMO). The index ranges
22+
## from -80 to 30. It depends on the sea-ice concentration and on Risk Index Values,
23+
## which are assigned to a vessel according to its structural properties and according
24+
## to ice thickness (and age). The maximum RIO refers to navigation in open water.
25+
## Navigation under conditions of negative RIO values is restricted to some types
26+
## of vessels. Navigation should generally be avoided where RIO < -10.
27+
28+
# table of Risk Index Values (IMO, MSC.1/Circ.1519 6 June 2016)
29+
# https://www.imorules.com/GUID-2C1D86CB-5D58-490F-B4D4-46C057E1D102.html
30+
rivSH = RIV/riv_MSC.1_Circ.1519_6_June_2016.csv
31+
32+
# colormap for model/observations
33+
colormapNameResult = RdYlBu
34+
# whether the colormap is indexed or continuous
35+
colormapTypeResult = indexed
36+
# color indices into colormapName for filled contours
37+
colormapIndicesResult = [0, 56, 85, 170, 198, 227, 241, 248, 255, 255]
38+
# colormap levels/values for contour boundaries
39+
colorbarLevelsResult = numpy.linspace(-10., 30., 9)
40+
41+
# Months or seasons to plot (Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct,
42+
# Nov, Dec, JFM, AMJ, JAS, OND, ANN)
43+
seasons = ['AMJ', 'OND']
44+
45+
# comparison grid(s) on which to plot analysis
46+
comparisonGrids = ['antarctic']
47+
48+
# Polar Class of vessels, according to IMO, for which RIO maps will be generated.
49+
# Range is 1 to 12. Here the values 1-7 refer to the ‘Polar Classes’ PC1-PC7,
50+
# assigned by the International Association of Classification Societies (IACS).
51+
# A PC1 vessel is capable of year-round operations in all polar waters. PC2 and PC3
52+
# vessels can navigate in 2.5 m (or more) thick ice. The values 8-11 correspond
53+
# to the Finnish-Swedish ice classes 'IA Super', 'IA', 'IB' and 'IC'.
54+
# The last value, 12, refers to ‘Not-Ice-Strengthened’ ships, all vessels without
55+
# a Polar Class.
56+
polarClass = 6
57+
58+
# reference floe thicknesses (m) for calculation of the Risk Index Value (RIV)
59+
# The thicknesses are intended to render the type of ice as defined by IMO.
60+
# There must be as many values as there are types of ice in the RIV table.
61+
# The first value has to be zero.
62+
h_to_typeofice = [0, 0.005, 0.1, 0.15, 0.3, 0.5, 0.7, 1, 1.2, 1.7, 2, 2.5]
63+
64+
# whether to use sea-ice categories for sea-ice concentration and thickness
65+
useIceCategories = False
66+
67+
# minimum lat and reference lon for sea ice plots in the southern hemisphere
68+
minimumLatitude = -50
69+
referenceLongitude = 180
70+
71+
# arrange subplots vertically?
72+
vertical = False
73+
74+
The option ``vertical = True`` can be used to plot 3 panels one above another
75+
(resulting in a tall, thin image) rather than next to each other, the default
76+
(resulting in a short, wide image).
77+
78+
For details on the remaining configuration options, see:
79+
* :ref:`config_colormaps`
80+
* :ref:`config_seasons`
81+
* :ref:`config_comparison_grids`
82+
83+
Example Result
84+
--------------
85+
86+
.. image:: examples/risk_index_outcome_sh.png
87+
:width: 720 px
88+
:align: center

‎docs/users_guide/tasks/examples/risk_index_outcome_nh.png‎

494 KB
Loading

‎docs/users_guide/tasks/examples/risk_index_outcome_sh.png‎

299 KB
Loading

‎mpas_analysis/default.cfg‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4800,7 +4800,7 @@ colorbarLevelsResult = numpy.linspace(-10., 30., 9)
48004800

48014801
# Months or seasons to plot (Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct,
48024802
# Nov, Dec, JFM, AMJ, JAS, OND, ANN)
4803-
seasons = ['AMJ','OND']
4803+
seasons = ['AMJ', 'OND']
48044804

48054805
# comparison grid(s) on which to plot analysis
48064806
comparisonGrids = ['arctic']
@@ -4829,7 +4829,7 @@ minimumLatitude = 50
48294829
referenceLongitude = 0
48304830

48314831
# arrange subplots vertically?
4832-
#vertical = False
4832+
vertical = False
48334833

48344834

48354835
[climatologyMapRiskIndexOutcomeSH]
@@ -4857,7 +4857,7 @@ colorbarLevelsResult = numpy.linspace(-10., 30., 9)
48574857

48584858
# Months or seasons to plot (Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct,
48594859
# Nov, Dec, JFM, AMJ, JAS, OND, ANN)
4860-
seasons = ['AMJ','OND']
4860+
seasons = ['AMJ', 'OND']
48614861

48624862
# comparison grid(s) on which to plot analysis
48634863
comparisonGrids = ['antarctic']
@@ -4886,7 +4886,7 @@ minimumLatitude = -50
48864886
referenceLongitude = 180
48874887

48884888
# arrange subplots vertically?
4889-
#vertical = False
4889+
vertical = False
48904890

48914891

48924892
[climatologyMapSeaIceProductionNH]

‎mpas_analysis/obs/observational_datasets.xml‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2157,6 +2157,54 @@
21572157
</nameInDocs>
21582158
</observation>
21592159

2160+
<observation>
2161+
<name>
2162+
Risk Index Values
2163+
</name>
2164+
<component>
2165+
seaice
2166+
</component>
2167+
<description>
2168+
This data set contains the Risk Index Values in Table 1.3 of the
2169+
International Maritime Organization rules within the Polar Operational
2170+
Limit Assessment Risk Indexing System (POLARIS). The basis of POLARIS is
2171+
an evaluation of the risks posed to the ship by ice conditions in relation
2172+
to the ship's assigned ice class.
2173+
</description>
2174+
<source>
2175+
[International Maritime Organization (IMO) Rules Website](https://www.imorules.com/GUID-2C1D86CB-5D58-490F-B4D4-46C057E1D102.html)
2176+
</source>
2177+
<releasePolicy>
2178+
Unknown, openly available on website.
2179+
</releasePolicy>
2180+
<references>
2181+
[International Maritime Organization (2016)](https://www.imorules.com/GUID-2C1D86CB-5D58-490F-B4D4-46C057E1D102.html)
2182+
</references>
2183+
<bibtex>
2184+
@misc{IMO2016,
2185+
author = {International Maritime Organization},
2186+
title = {{Guidance on Methodologies for Assessing Operational Capabilities and Limitations in Ice}},
2187+
year = {2016},
2188+
howpublished = {{IMO Publications and Documents - Circulars - Maritime Safety Committee - MSC.1/Circular.1519 - Guidance on Methodologies for Assessing Operational Capabilities and Limitations in Ice - (6 June 2016) - Appendix - Methodology for Assessing Operational Capabilities and Limitations in Ice: Polar Operational Limit Assessment Risk Indexing System (POLARIS)}}
2189+
url = {https://www.imorules.com/GUID-2C1D86CB-5D58-490F-B4D4-46C057E1D102.html}
2190+
}
2191+
</bibtex>
2192+
<dataUrls>
2193+
</dataUrls>
2194+
<preprocessing>
2195+
</preprocessing>
2196+
<tasks>
2197+
- climatologyMapRiskIndexOutcomeNH
2198+
- climatologyMapRiskIndexOutcomeSH
2199+
</tasks>
2200+
<subdirectory>
2201+
SeaIce/RIV
2202+
</subdirectory>
2203+
<nameInDocs>
2204+
imo_riv
2205+
</nameInDocs>
2206+
</observation>
2207+
21602208
<!-- ICEBERGS -->
21612209

21622210
<observation>

0 commit comments

Comments
 (0)