Skip to content
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.

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

Merge back v3p0p0 #3960

Merged
merged 25 commits into from
Jan 27, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
71e6863
Add release highlights and pin rc version (#3898)
bjlittle Oct 2, 2020
3b9a0bd
reorder release highlights (#3899)
bjlittle Oct 2, 2020
1b59ffe
Add whatsnew announcement (#3900)
bjlittle Oct 2, 2020
a9c1e79
Fix spelling (#3903)
tkknight Oct 5, 2020
6d36021
Fix unit label handling (#3902)
znicholls Oct 7, 2020
c797fc8
Release Docs Improvements (#3895)
trexfeathers Oct 12, 2020
2e6aa01
Relax setup.py setup requirements (#3909)
bjlittle Oct 15, 2020
5da592f
Updated CF saver version in User Guide and docstring (#3925)
jonseddon Nov 24, 2020
0ff0dca
Migrate to cirrus-ci (#3928)
bjlittle Nov 25, 2020
28572d7
ignore url for doc link check (#3929)
bjlittle Nov 25, 2020
8d5dee0
whatsnew for coord default units (#3924)
rcomer Nov 25, 2020
c9d0dad
Cube._summary_coord_extra: efficiency and bugfix (#3922)
rcomer Nov 25, 2020
723a2f4
Add Documentation Title Case Capitalization (#3940)
bjlittle Dec 22, 2020
6e6fe03
CI requirements drop pip packages (#3939)
bjlittle Dec 23, 2020
83d1b72
update links (#3942)
rcomer Dec 30, 2020
5c8edc1
Add support for 1-d weights in collapse. (#3943)
pp-mo Jan 8, 2021
805a4fe
Remove warning for convert_units on lazy data (#3951)
rcomer Jan 20, 2021
e689ef4
drop stickler references in docs (#3953)
bjlittle Jan 25, 2021
62dcb17
update docs for travis-ci to cirrus-ci (#3954)
bjlittle Jan 25, 2021
9c6d778
docs for nox (#3955)
bjlittle Jan 25, 2021
78de3c6
Resolve test coverage (#3947)
bjlittle Jan 25, 2021
ca642ee
pin v3.0.0 version and whatnew date (#3956)
bjlittle Jan 25, 2021
8222f65
update github ci checks image (#3957)
bjlittle Jan 25, 2021
4b8df18
merge-back of v3.0.0
bjlittle Jan 26, 2021
12ab1cb
Merge branch 'master' into merge-back-v3p0p0
trexfeathers Jan 27, 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
2 changes: 1 addition & 1 deletion docs/iris/gallery_code/general/plot_SOI_filtering.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Applying a filter to a time-series
Applying a Filter to a Time-Series
==================================
This example demonstrates low pass filtering a time-series by applying a
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Colouring anomaly data with logarithmic scaling
Colouring Anomaly Data With Logarithmic Scaling
===============================================
In this example, we need to plot anomaly data where the values have a
Expand Down
2 changes: 1 addition & 1 deletion docs/iris/gallery_code/general/plot_coriolis.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Deriving the Coriolis frequency over the globe
Deriving the Coriolis Frequency Over the Globe
==============================================
This code computes the Coriolis frequency and stores it in a cube with
Expand Down
2 changes: 1 addition & 1 deletion docs/iris/gallery_code/general/plot_cross_section.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Cross section plots
Cross Section Plots
===================
This example demonstrates contour plots of a cross-sectioned multi-dimensional
Expand Down
2 changes: 1 addition & 1 deletion docs/iris/gallery_code/general/plot_custom_aggregation.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Calculating a custom statistic
Calculating a Custom Statistic
==============================
This example shows how to define and use a custom
Expand Down
2 changes: 1 addition & 1 deletion docs/iris/gallery_code/general/plot_custom_file_loading.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Loading a cube from a custom file format
Loading a Cube From a Custom File Format
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This example shows how a custom text file can be loaded using the standard Iris
Expand Down
2 changes: 1 addition & 1 deletion docs/iris/gallery_code/general/plot_global_map.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Quickplot of a 2d cube on a map
Quickplot of a 2D Cube on a Map
===============================
This example demonstrates a contour plot of global air temperature. The plot
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Multi-line temperature profile plot
Multi-Line Temperature Profile Plot
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
"""
Expand Down
2 changes: 1 addition & 1 deletion docs/iris/gallery_code/general/plot_polar_stereo.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Example of a polar stereographic plot
Example of a Polar Stereographic Plot
=====================================
Demonstrates plotting data that are defined on a polar stereographic
Expand Down
2 changes: 1 addition & 1 deletion docs/iris/gallery_code/general/plot_polynomial_fit.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Fitting a polynomial
Fitting a Polynomial
====================
This example demonstrates computing a polynomial fit to 1D data from an Iris
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Plotting in different projections
Plotting in Different Projections
=================================
This example shows how to overlay data and graphics in different projections,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Rotated pole mapping
Rotated Pole Mapping
=====================
This example uses several visualisation methods to achieve an array of
Expand Down
2 changes: 1 addition & 1 deletion docs/iris/gallery_code/meteorology/plot_COP_1d.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Global average annual temperature plot
Global Average Annual Temperature Plot
======================================
Produces a time-series plot of North American temperature forecasts for 2
Expand Down
2 changes: 1 addition & 1 deletion docs/iris/gallery_code/meteorology/plot_COP_maps.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Global average annual temperature maps
Global Average Annual Temperature Maps
======================================
Produces maps of global temperature forecasts from the A1B and E1 scenarios.
Expand Down
2 changes: 1 addition & 1 deletion docs/iris/gallery_code/meteorology/plot_TEC.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Ionosphere space weather
Ionosphere Space Weather
========================
This space weather example plots a filled contour of rotated pole point
Expand Down
2 changes: 1 addition & 1 deletion docs/iris/gallery_code/meteorology/plot_hovmoller.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Hovmoller diagram of monthly surface temperature
Hovmoller Diagram of Monthly Surface Temperature
================================================
This example demonstrates the creation of a Hovmoller diagram with fine control
Expand Down
2 changes: 1 addition & 1 deletion docs/iris/gallery_code/meteorology/plot_lagged_ensemble.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Seasonal ensemble model plots
Seasonal Ensemble Model Plots
=============================
This example demonstrates the loading of a lagged ensemble dataset from the
Expand Down
4 changes: 2 additions & 2 deletions docs/iris/gallery_code/meteorology/plot_wind_speed.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
Plotting wind direction using quiver
===========================================================
Plotting Wind Direction Using Quiver
====================================
This example demonstrates using quiver to plot wind speed contours and wind
direction arrows from wind vector component input data. The vector components
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Oceanographic profiles and T-S diagrams
Oceanographic Profiles and T-S Diagrams
=======================================
This example demonstrates how to plot vertical profiles of different
Expand Down
2 changes: 1 addition & 1 deletion docs/iris/gallery_code/oceanography/plot_load_nemo.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Load a time series of data from the NEMO model
Load a Time Series of Data From the NEMO Model
==============================================
This example demonstrates how to load multiple files containing data output by
Expand Down
5 changes: 2 additions & 3 deletions docs/iris/src/common_links.inc
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,8 @@
.. _iris-sample-data: https://github.com/SciTools/iris-sample-data
.. _test-iris-imagehash: https://github.com/SciTools/test-iris-imagehash
.. _readthedocs.yml: https://github.com/SciTools/iris/blob/master/requirements/ci/readthedocs.yml
.. _travis-ci: https://travis-ci.org/github/SciTools/iris
.. _.travis.yml: https://github.com/SciTools/iris/blob/master/.travis.yml
.. _.stickler.yml: https://github.com/SciTools/iris/blob/master/.stickler.yml
.. _cirrus-ci: https://cirrus-ci.com/github/SciTools/iris
.. _.cirrus.yml: https://github.com/SciTools/iris/blob/master/.cirrus.yml
.. _.flake8.yml: https://github.com/SciTools/iris/blob/master/.flake8
.. _GitHub Help Documentation: https://docs.github.com/en/github
.. _using git: https://docs.github.com/en/github/using-git
Expand Down
8 changes: 5 additions & 3 deletions docs/iris/src/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ def autolog(message):
"menu_links_name": "Support",
"menu_links": [
(
'<i class="fa fa-github fa-fw"></i> Source code',
'<i class="fa fa-github fa-fw"></i> Source Code',
"https://github.com/SciTools/iris",
),
(
Expand All @@ -242,11 +242,11 @@ def autolog(message):
"https://groups.google.com/forum/#!forum/scitools-iris-dev",
),
(
'<i class="fa fa-question fa-fw"></i> StackOverflow for "How do I?"',
'<i class="fa fa-question fa-fw"></i> StackOverflow for "How Do I?"',
"https://stackoverflow.com/questions/tagged/python-iris",
),
(
'<i class="fa fa-book fa-fw"></i> Legacy documentation',
'<i class="fa fa-book fa-fw"></i> Legacy Documentation',
"https://scitools.org.uk/iris/docs/v2.4.0/index.html",
),
],
Expand All @@ -269,6 +269,8 @@ def autolog(message):
"http://schacon.github.com/git",
"http://scitools.github.com/cartopy",
"http://www.wmo.int/pages/prog/www/DPFS/documents/485_Vol_I_en_colour.pdf",
"https://software.ac.uk/how-cite-software",
"http://www.esrl.noaa.gov/psd/data/gridded/conventions/cdc_netcdf_standard.shtml",
]

# list of sources to exclude from the build.
Expand Down
6 changes: 3 additions & 3 deletions docs/iris/src/copyright.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@

Iris copyright, licensing and contributors
Iris Copyright, Licensing and Contributors
==========================================

Iris code
Iris Code
---------

All Iris source code, unless explicitly stated, is ``Copyright Iris
Expand All @@ -20,7 +20,7 @@ You should find all source files with the following header:
licensing details.


Iris documentation and examples
Iris Documentation and Examples
-------------------------------

All documentation, examples and sample data found on this website and in source repository
Expand Down
Binary file modified docs/iris/src/developers_guide/ci_checks.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/iris/src/developers_guide/contributing_changes.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

.. _contributing.changes:

Contributing your changes
Contributing Your Changes
=========================

.. toctree::
Expand Down
27 changes: 8 additions & 19 deletions docs/iris/src/developers_guide/contributing_ci_tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ automatically when a pull request is created, updated or merged against
Iris **master**. The checks performed are:

* :ref:`testing_cla`
* :ref:`testing_travis`
* :ref:`testing_stickler`
* :ref:`testing_cirrus`


.. _testing_cla:
Expand All @@ -24,33 +23,23 @@ A bot that checks the user who created the pull request has signed the
please see https://scitools.org.uk/organisation.html#governance


.. _testing_stickler:
.. _testing_cirrus:

Stickler CI
***********

Automatically enforces coding standards. The configuration file named
`.stickler.yml`_ is in the Iris_ root directory. For more information see
https://stickler-ci.com/.


.. _testing_travis:

Travis-CI
Cirrus-CI
*********

The unit and integration tests in Iris are an essential mechanism to ensure
that the Iris code base is working as expected. :ref:`developer_running_tests`
may be run manually but to ensure the checks are performed a
continuous integration testing tool named `travis-ci`_ is used.
continuous integration testing tool named `cirrus-ci`_ is used.

A `travis-ci`_ configuration file named `.travis.yml`_
is in the Iris repository which tells travis-ci what commands to run. The
A `cirrus-ci`_ configuration file named `.cirrus.yml`_
is in the Iris repository which tells Cirrus-CI what commands to run. The
commands include retrieving the Iris code base and associated test files using
conda and then running the tests. `travis-ci`_ allows for a matrix of tests to
conda and then running the tests. `cirrus-ci`_ allows for a matrix of tests to
be performed to ensure that all expected variations test successfully.

The `travis-ci`_ tests are run automatically against the `Iris`_ master
The `cirrus-ci`_ tests are run automatically against the `Iris`_ master
repository when a pull request is submitted, updated or merged.

GitHub Checklist
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

.. _code_formatting:

Code formatting
Code Formatting
===============

To ensure a consistent code format throughout Iris, we recommend using
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. _contributing.documentation.codebase:

Contributing to the code base
Contributing to the Code Base
=============================

.. toctree::
Expand Down
12 changes: 6 additions & 6 deletions docs/iris/src/developers_guide/contributing_deprecations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ one release, before removing/updating it in the next
`major release <http://semver.org/>`_.


Adding a deprecation
Adding a Deprecation
====================

.. _removing-a-public-api:

Removing a public API
Removing a Public API
---------------------

The simplest form of deprecation occurs when you need to remove a public
Expand Down Expand Up @@ -49,7 +49,7 @@ Under these circumstances the following points apply:
- You should check the documentation for references to the deprecated
API and update them as appropriate.

Changing a default
Changing a Default
------------------

When you need to change the default behaviour of a public API the
Expand All @@ -74,7 +74,7 @@ API:
deprecation warning and corresponding Sphinx deprecation directive.


Removing a deprecation
Removing a Deprecation
======================

When the time comes to make a new major release you should locate any
Expand All @@ -83,15 +83,15 @@ minimum period described previously. Locating deprecated APIs can easily
be done by searching for the Sphinx deprecation directives and/or
deprecation warnings.

Removing a public API
Removing a Public API
---------------------

The deprecated API should be removed and any corresponding documentation
and/or example code should be removed/updated as appropriate.

.. _iris_developer_future:

Changing a default
Changing a Default
------------------

- You should update the initial state of the relevant boolean attribute
Expand Down
10 changes: 5 additions & 5 deletions docs/iris/src/developers_guide/contributing_documentation.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

.. _contributing.documentation:

Contributing to the documentation
Contributing to the Documentation
---------------------------------

Documentation is important and we encourage any improvements that can be made.
Expand All @@ -28,7 +28,7 @@ The build can be run from the documentation directory ``iris/docs/iris/src``.

The build output for the html is found in the ``_build/html`` sub directory.
When updating the documentation ensure the html build has *no errors* or
*warnings* otherwise it may fail the automated `travis-ci`_ build.
*warnings* otherwise it may fail the automated `cirrus-ci`_ build.

Once the build is complete, if it is rerun it will only rebuild the impacted
build artefacts so should take less time.
Expand All @@ -50,7 +50,7 @@ This is useful for a final test before committing your changes.
have been promoted to be **errors** to ensure they are addressed.
This **only** applies when ``make html`` is run.

.. _travis-ci: https://travis-ci.org/github/SciTools/iris
.. _cirrus-ci: https://cirrus-ci.com/github/SciTools/iris

.. _contributing.documentation.testing:

Expand Down Expand Up @@ -99,7 +99,7 @@ or ignore the url.
``spelling_word_list_filename``.


.. note:: In addition to the automated `travis-ci`_ build of all the
.. note:: In addition to the automated `cirrus-ci`_ build of all the
documentation build options above, the
https://readthedocs.org/ service is also used. The configuration
of this held in a file in the root of the
Expand All @@ -112,7 +112,7 @@ or ignore the url.

.. _contributing.documentation.api:

Generating API documentation
Generating API Documentation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In order to auto generate the API documentation based upon the docstrings a
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

.. _development_where_to_start:

Getting involved
Getting Involved
----------------

Iris_ is an Open Source project hosted on Github and as such anyone with a
Expand Down
Loading