Skip to content

Commit

Permalink
Merge pull request #1054 from xylar/fix-docs
Browse files Browse the repository at this point in the history
Fix several errors in the docs
  • Loading branch information
xylar authored Jan 18, 2025
2 parents 99071b9 + 0a5df49 commit b892c8c
Show file tree
Hide file tree
Showing 9 changed files with 41 additions and 36 deletions.
1 change: 1 addition & 0 deletions docs/tutorials/dev_getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -442,6 +442,7 @@ following:
If you find that new jobs are being lanuched for ncremap tasks, set:

.. code-block:: ini
[execute]
...
Expand Down
3 changes: 1 addition & 2 deletions docs/users_guide/tasks/antshipTransects.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _task_antshipTransects:

antshipTransects
=============
================

An analysis task for interpolating MPAS fields to transects from ship-based observations around Antarctica and comparing them.

Expand All @@ -15,7 +15,6 @@ Configuration Options

The following configuration options are available for this task::

[antshipTransects]
[antshipTransects]
## options related to plotting model ship CTD transects.

Expand Down
2 changes: 1 addition & 1 deletion docs/users_guide/tasks/climatologyMapSeaIceAlbedoNH.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _task_climatologyMapSeaIceAlbedoNH:

climatologyMapSeaIceAlbedoNH
==========================
============================

An analysis task for plotting maps of Arctic sea ice broadband albedo.
Care must be taken when evaluating albedo - long-time averages do not
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _task_climatologyMapSeaIceVolumeTendencyThermoNH:

climatologyMapSeaIceVolumeTendencyThermoNH
========================================
==========================================

An analysis task for plotting maps of Arctic sea ice volume tendency due to thermodynamics.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _task_climatologyMapSeaIceVolumeTendencyThermoSH:

climatologyMapSeaIceVolumeTendencyThermoSH
========================================
==========================================

An analysis task for plotting maps of Antarctic sea ice volume tendency due to thermodynamics.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _task_climatologyMapSeaIceVolumeTendencyTranspNH:

climatologyMapSeaIceVolumeTendencyTranspNH
========================================
==========================================

An analysis task for plotting maps of Arctic sea ice volume tendency due to transport.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _task_climatologyMapSeaIceVolumeTendencyTranspSH:

climatologyMapSeaIceVolumeTendencyTranspSH
========================================
==========================================

An analysis task for plotting maps of Antarctic sea ice volume tendency due to transport.

Expand Down
6 changes: 3 additions & 3 deletions docs/users_guide/tasks/osnapTransects.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
.. _task_osnapTransects:

osnapTransects
=============
==============

An analysis task for interpolating MPAS fields to
`Overturning in the Subpolar North Atlantic Program (OSNAP)`_ transects
`Overturning in the Subpolar North Atlantic Program (OSNAP)`_ transects
and comparing them with ship-based observations.

Component and Tags::
Expand Down Expand Up @@ -121,7 +121,7 @@ For details on these configuration options, see:
Observations
------------

:ref:`osnap`
:ref:`osnap_t_s`

Example Result
--------------
Expand Down
57 changes: 31 additions & 26 deletions mpas_analysis/obs/observational_datasets.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1042,11 +1042,16 @@
ocean
</component>
<description>
AntShip
----
Southern Ocean (90°S-45°S) conservative temperature and absolute salinity profiles compilation (OCEAN ICE D1.1)
Southern Ocean (90°S-45°S) conservative temperature and absolute salinity
profiles compilation (OCEAN ICE D1.1)

This profile compilation contains conservative temperature and absolute salinity profiles computed from ship CTD, Argo floats and seal-borne profilers in the Southern Ocean (90°S-45°S) since 1972, using the GSW toolbox. It provides with an opportunity to investigate the broad scale climatology of the Southern Ocean hydrography on and off the continental shelf and facilitate localized timeseries analysis of the variability across various timescales.
This profile compilation contains conservative temperature and absolute
salinity profiles computed from ship CTD, Argo floats and seal-borne
profilers in the Southern Ocean (90°S-45°S) since 1972, using the GSW
toolbox. It provides with an opportunity to investigate the broad scale
climatology of the Southern Ocean hydrography on and off the continental
shelf and facilitate localized timeseries analysis of the variability
across various timescales.

</description>
<source>
Expand Down Expand Up @@ -1605,27 +1610,27 @@
ocean
</component>
<description>
OSNAP is designed to provide a continuous record of the full-water
column, trans-basin fluxes of heat, mass and freshwater in the subpolar
North Atlantic. It consists of two legs: one extending from southern
Labrador to the southwestern tip of Greenland across the mouth of the
Labrador Sea (OSNAP West), and the second from the southeastern tip of
Greenland to Scotland (OSNAP East). The observing system also includes
subsurface floats (OSNAP Floats) in order to trace the pathways of
overflow waters in the basin and to assess the connectivity of currents
crossing the OSNAP line. The location of the OSNAP East and West legs
purposefully melds with a number of long-term observational efforts in
the North Atlantic: the Canadian repeat AR7W program in the Labrador
Sea; the German Labrador Sea western boundary array at 53°N; the
global Ocean Observatories Initiative node to be placed in the
southwestern Irminger Sea; the repeat A1E/AR7E hydrographic sections
across the Irminger and Iceland basins; and the Ellett line in the
Rockall region. Importantly, this observing system, in conjunction with
the RAPID/MOCHA array at 26ºN and the EU THOR/NACLIM program, will
provide a comprehensive measure of the Atlantic Meridional Overturning
Circulation (AMOC) and provide a means to evaluate intergyre
connectivity in the North Atlantic. OSNAP is a collaborative effort,
which includes several countries including US, Canada, China, France,
OSNAP is designed to provide a continuous record of the full-water
column, trans-basin fluxes of heat, mass and freshwater in the subpolar
North Atlantic. It consists of two legs: one extending from southern
Labrador to the southwestern tip of Greenland across the mouth of the
Labrador Sea (OSNAP West), and the second from the southeastern tip of
Greenland to Scotland (OSNAP East). The observing system also includes
subsurface floats (OSNAP Floats) in order to trace the pathways of
overflow waters in the basin and to assess the connectivity of currents
crossing the OSNAP line. The location of the OSNAP East and West legs
purposefully melds with a number of long-term observational efforts in
the North Atlantic: the Canadian repeat AR7W program in the Labrador
Sea; the German Labrador Sea western boundary array at 53°N; the
global Ocean Observatories Initiative node to be placed in the
southwestern Irminger Sea; the repeat A1E/AR7E hydrographic sections
across the Irminger and Iceland basins; and the Ellett line in the
Rockall region. Importantly, this observing system, in conjunction with
the RAPID/MOCHA array at 26ºN and the EU THOR/NACLIM program, will
provide a comprehensive measure of the Atlantic Meridional Overturning
Circulation (AMOC) and provide a means to evaluate intergyre
connectivity in the North Atlantic. OSNAP is a collaborative effort,
which includes several countries including US, Canada, China, France,
Germany, Netherlands and the UK.
</description>
<source>
Expand All @@ -1646,7 +1651,7 @@
- preprocess_observations/preprocessingOSNAP30day.ipynb
</preprocessing>
<tasks>
- climatologyMapOSNAP
- osnapTransects
</tasks>
<subdirectory>
Ocean/OSNAP
Expand Down

0 comments on commit b892c8c

Please sign in to comment.