Skip to content

Cubeprinter adopt #4206

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 23 commits into from
Aug 10, 2021
Merged

Cubeprinter adopt #4206

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
e1a1b53
Adopt new-style Cube printout.
pp-mo Feb 8, 2021
b3861fa
Fix some import orderings.
pp-mo Jun 23, 2021
8ca658a
Replace old cube summary code with new CubeSummary-based implementation.
pp-mo Jun 23, 2021
d1e43cf
Removed additional colons.
pp-mo Jun 23, 2021
d2c86d1
Slightly altered behaviour + specific test fixes.
pp-mo Jun 23, 2021
bfb7970
Test result changes.
pp-mo Jun 23, 2021
07151fd
Code standard fixes.
pp-mo Jun 23, 2021
e1d4655
More test fixes.
pp-mo Jun 23, 2021
df784a8
Doctest fixes.
pp-mo Jun 23, 2021
7045e7e
Fix doctest output for python 3.8.
pp-mo Jun 24, 2021
7be7520
Fix merged docs test.
pp-mo Jun 29, 2021
552a45e
Make cube-summary list attributes last.
pp-mo Jul 22, 2021
bcb689d
Fix affected tests.
pp-mo Jul 22, 2021
57ecd56
Another test fix.
pp-mo Jul 22, 2021
3f723bd
Reformat TODO string to aid IDE recognition.
trexfeathers Aug 5, 2021
01a73f2
CubePrinter tab size constants.
trexfeathers Aug 5, 2021
b548b37
CubePrinter don't bother assigning cube_summary on ingestion.
trexfeathers Aug 5, 2021
85fd3cf
cube_printout docstring fixes.
trexfeathers Aug 6, 2021
4d8859c
Cube summary align cell methods with other tabbed content.
trexfeathers Aug 6, 2021
46b6d54
Remove CubePrinter TODO.
trexfeathers Aug 6, 2021
1f9cf8c
Remove CubeSummary TODO.
trexfeathers Aug 6, 2021
83730c3
Remove commented cube summary code.
trexfeathers Aug 9, 2021
319963e
Cube summary what's new entries.
trexfeathers Aug 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
126 changes: 63 additions & 63 deletions docs/src/further_topics/lenient_maths.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,26 +68,26 @@ represents the output of an low-resolution global atmospheric ``experiment``,
.. doctest:: lenient-example

>>> print(experiment)
air_potential_temperature / (K) (model_level_number: 15; grid_latitude: 100; grid_longitude: 100)
Dimension coordinates:
model_level_number x - -
grid_latitude - x -
grid_longitude - - x
Auxiliary coordinates:
atmosphere_hybrid_height_coordinate x - -
sigma x - -
surface_altitude - x x
Derived coordinates:
altitude x x x
Scalar coordinates:
forecast_period: 0.0 hours
forecast_reference_time: 2009-09-09 17:10:00
time: 2009-09-09 17:10:00
Attributes:
Conventions: CF-1.5
STASH: m01s00i004
experiment-id: RT3 50
source: Data from Met Office Unified Model 7.04
air_potential_temperature / (K) (model_level_number: 15; grid_latitude: 100; grid_longitude: 100)
Dimension coordinates:
model_level_number x - -
grid_latitude - x -
grid_longitude - - x
Auxiliary coordinates:
atmosphere_hybrid_height_coordinate x - -
sigma x - -
surface_altitude - x x
Derived coordinates:
altitude x x x
Scalar coordinates:
forecast_period 0.0 hours
forecast_reference_time 2009-09-09 17:10:00
time 2009-09-09 17:10:00
Attributes:
Conventions CF-1.5
STASH m01s00i004
experiment-id RT3 50
source Data from Met Office Unified Model 7.04

Consider also the following :class:`~iris.cube.Cube`, which has the same global
spatial extent, and acts as a ``control``,
Expand All @@ -96,41 +96,41 @@ spatial extent, and acts as a ``control``,

>>> print(control)
air_potential_temperature / (K) (grid_latitude: 100; grid_longitude: 100)
Dimension coordinates:
grid_latitude x -
grid_longitude - x
Scalar coordinates:
model_level_number: 1
time: 2009-09-09 17:10:00
Attributes:
Conventions: CF-1.7
STASH: m01s00i004
source: Data from Met Office Unified Model 7.04
Dimension coordinates:
grid_latitude x -
grid_longitude - x
Scalar coordinates:
model_level_number 1
time 2009-09-09 17:10:00
Attributes:
Conventions CF-1.7
STASH m01s00i004
source Data from Met Office Unified Model 7.04

Now let's subtract these cubes in order to calculate a simple ``difference``,

.. doctest:: lenient-example

>>> difference = experiment - control
>>> print(difference)
unknown / (K) (model_level_number: 15; grid_latitude: 100; grid_longitude: 100)
Dimension coordinates:
model_level_number x - -
grid_latitude - x -
grid_longitude - - x
Auxiliary coordinates:
atmosphere_hybrid_height_coordinate x - -
sigma x - -
surface_altitude - x x
Derived coordinates:
altitude x x x
Scalar coordinates:
forecast_period: 0.0 hours
forecast_reference_time: 2009-09-09 17:10:00
time: 2009-09-09 17:10:00
Attributes:
experiment-id: RT3 50
source: Data from Met Office Unified Model 7.04
unknown / (K) (model_level_number: 15; grid_latitude: 100; grid_longitude: 100)
Dimension coordinates:
model_level_number x - -
grid_latitude - x -
grid_longitude - - x
Auxiliary coordinates:
atmosphere_hybrid_height_coordinate x - -
sigma x - -
surface_altitude - x x
Derived coordinates:
altitude x x x
Scalar coordinates:
forecast_period 0.0 hours
forecast_reference_time 2009-09-09 17:10:00
time 2009-09-09 17:10:00
Attributes:
experiment-id RT3 50
source Data from Met Office Unified Model 7.04

Note that, cube maths automatically takes care of broadcasting the
dimensionality of the ``control`` up to that of the ``experiment``, in order to
Expand Down Expand Up @@ -204,21 +204,21 @@ time perform **strict** cube maths instead,
... difference = experiment - control
...
>>> print(difference)
unknown / (K) (model_level_number: 15; grid_latitude: 100; grid_longitude: 100)
Dimension coordinates:
model_level_number x - -
grid_latitude - x -
grid_longitude - - x
Auxiliary coordinates:
atmosphere_hybrid_height_coordinate x - -
sigma x - -
surface_altitude - x x
Derived coordinates:
altitude x x x
Scalar coordinates:
time: 2009-09-09 17:10:00
Attributes:
source: Data from Met Office Unified Model 7.04
unknown / (K) (model_level_number: 15; grid_latitude: 100; grid_longitude: 100)
Dimension coordinates:
model_level_number x - -
grid_latitude - x -
grid_longitude - - x
Auxiliary coordinates:
atmosphere_hybrid_height_coordinate x - -
sigma x - -
surface_altitude - x x
Derived coordinates:
altitude x x x
Scalar coordinates:
time 2009-09-09 17:10:00
Attributes:
source Data from Met Office Unified Model 7.04

Although the numerical result of this strict cube maths operation is identical,
it is not as rich in metadata as the :ref:`lenient alternative <lenient example>`.
Expand Down
32 changes: 16 additions & 16 deletions docs/src/further_topics/metadata.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,22 +108,22 @@ For example, given the following :class:`~iris.cube.Cube`,

>>> print(cube)
air_temperature / (K) (time: 240; latitude: 37; longitude: 49)
Dimension coordinates:
time x - -
latitude - x -
longitude - - x
Auxiliary coordinates:
forecast_period x - -
Scalar coordinates:
forecast_reference_time: 1859-09-01 06:00:00
height: 1.5 m
Attributes:
Conventions: CF-1.5
Model scenario: A1B
STASH: m01s03i236
source: Data from Met Office Unified Model 6.05
Cell methods:
mean: time (6 hour)
Dimension coordinates:
time x - -
latitude - x -
longitude - - x
Auxiliary coordinates:
forecast_period x - -
Scalar coordinates:
forecast_reference_time 1859-09-01 06:00:00
height 1.5 m
Cell methods:
mean time (6 hour)
Attributes:
Conventions CF-1.5
Model scenario A1B
STASH m01s03i236
source Data from Met Office Unified Model 6.05

We can easily get all of the associated metadata of the :class:`~iris.cube.Cube`
using the ``metadata`` property:
Expand Down
20 changes: 10 additions & 10 deletions docs/src/userguide/cube_maths.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,16 +56,16 @@ but with the data representing their difference:

>>> print(t_last - t_first)
unknown / (K) (latitude: 37; longitude: 49)
Dimension coordinates:
latitude x -
longitude - x
Scalar coordinates:
forecast_reference_time: 1859-09-01 06:00:00
height: 1.5 m
Attributes:
Conventions: CF-1.5
Model scenario: E1
source: Data from Met Office Unified Model 6.05
Dimension coordinates:
latitude x -
longitude - x
Scalar coordinates:
forecast_reference_time 1859-09-01 06:00:00
height 1.5 m
Attributes:
Conventions CF-1.5
Model scenario E1
source Data from Met Office Unified Model 6.05


.. note::
Expand Down
Loading