Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 7 additions & 4 deletions .lycheeignore
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
https://biggus.readthedocs.io
https://cfconventions.org
https://doi.org/10.3390/jmse2010194
https://effbot.org
https://www.personal.psu.edu/cab38/ColorBrewer/ColorBrewer_updates.html
https://ibm-design-language.eu-de.mybluemix.net/design/language/resources/color-library
https://geoport.whoi.edu/thredds/dodsC/bathy/gom15
https://github.com
https://scitools.github.com/cartopy
https://biggus.readthedocs.io
https://stickler-ci.com
https://www.flaticon.com
https://doi.org/10.3390/jmse2010194
https://github.com
https://www.personal.psu.edu/cab38/ColorBrewer/ColorBrewer_updates.html

14 changes: 7 additions & 7 deletions docs/src/further_topics/dask_best_practices/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,13 @@ CPU available. This interacts badly with Dask:
* NumPy will generate enough threads to use all available CPUs even
if Dask is deliberately configured to only use a subset of CPUs. The
resulting sharing of CPUs between threads greatly reduces performance.
* `Dask is already designed to parallelise with NumPy arrays <https://docs
.dask.org/en/latest/array.html>`_, so adding NumPy's 'competing' layer of
parallelisation could cause unpredictable performance.
* `Dask is already designed to parallelise with NumPy arrays
<https://docs.dask.org/en/latest/array.html>`_, so adding NumPy's 'competing' layer
of parallelisation could cause unpredictable performance.

Therefore it is best to prevent NumPy performing its own parallelisation, `a
suggestion made in Dask's own documentation <https://docs.dask
.org/en/stable/array-best-practices.html#avoid-oversubscribing-threads>`_.
suggestion made in Dask's own documentation
<https://docs.dask.org/en/stable/array-best-practices.html#avoid-oversubscribing-threads>`_.
The following commands will ensure this in all scenarios:

in Python...
Expand Down Expand Up @@ -158,8 +158,8 @@ NetCDF Files

NetCDF files can include their own chunking specification. This is either
specified when creating the file, or is automatically assigned if one or
more of the dimensions is `unlimited <https://www.unidata.ucar
.edu/software/netcdf/docs/unlimited_dims.html>`_.
more of the dimensions is
`unlimited <https://www.unidata.ucar.edu/software/netcdf/docs/unlimited_dims.html>`_.
Importantly, netCDF chunk shapes are **not optimised for Dask
performance**.

Expand Down
17 changes: 6 additions & 11 deletions docs/src/whatsnew/2.3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,7 @@ Features
.. admonition:: Climatological Coordinate Support

Iris can now load, store and save `NetCDF climatological coordinates
<https://cfconventions.org/Data/cf-conventions/cf-conventions-1
.7/cf-conventions.html#climatological-statistics>`_. Any cube time
<https://cfconventions.org/Data/cf-conventions/cf-conventions-1.7/cf-conventions.html#climatological-statistics>`_. Any cube time
coordinate can be marked as a climatological time axis using the boolean
property: ``climatological``. The climatological bounds are stored in the
coordinate's ``bounds`` property.
Expand All @@ -41,9 +40,8 @@ Features
coordinate's ``bounds`` property are written to a NetCDF boundary variable
called '<coordinate-name>_bounds'. These are in place of a standard
'bounds' attribute and accompanying boundary variable. See below
for an `example adapted from CF conventions <https://cfconventions
.org/Data/cf-conventions/cf-conventions-1.7/cf-conventions
.html#climatological-statistics>`_:
for an
`example adapted from CF conventions <https://cfconventions.org/Data/cf-conventions/cf-conventions-1.7/cf-conventions.html#climatological-statistics>`_:

.. code-block:: none

Expand Down Expand Up @@ -116,8 +114,7 @@ Features

* New coordinate system: :class:`iris.coord_systems.Geostationary`,
including load and save support, based on the `CF Geostationary projection
definition <https://cfconventions
.org/cf-conventions/cf-conventions.html#_geostationary_projection>`_.
definition <https://cfconventions.org/cf-conventions/cf-conventions.html#_geostationary_projection>`_.

* :class:`iris.coord_systems.VerticalPerspective` can now be saved to and
loaded from NetCDF files.
Expand Down Expand Up @@ -164,8 +161,7 @@ Bugs Fixed
points.

* :class:`iris.coord_systems.VerticalPerspective` coordinate system now uses
the `CF Vertical perspective definition <https://cfconventions
.org/cf-conventions/cf-conventions.html#vertical-perspective>`_; had been
the `CF Vertical perspective definition <https://cfconventions.org/cf-conventions/cf-conventions.html#vertical-perspective>`_; had been
erroneously using Geostationary.

* :class:`~iris.coords.CellMethod` will now only use valid
Expand Down Expand Up @@ -227,8 +223,7 @@ Internal
========

* Iris now supports Proj4 up to version 5, but not yet 6 or beyond, pending
`fixes to some cartopy tests <https://github
.com/SciTools/cartopy/pull/1289#pullrequestreview-272774087>`_.
`fixes to some cartopy tests <https://github.com/SciTools/cartopy/pull/1289#pullrequestreview-272774087>`_.

* Iris now requires Dask >= 1.2 to allow for improved coordinate equality
checks.
Expand Down
Loading