diff --git a/README.md b/README.md index 6adf27d85b..a8a9787d05 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@

- Iris is a powerful, format-agnostic, community-driven Python library for + Iris is a powerful, format-agnostic, community-driven Python package for analysing and visualising Earth science data

@@ -15,7 +15,7 @@ Travis-CI - Documentation Status black

-
- - -

Table of contents

- -[](TOC) - -+ [Overview](#overview) -+ [Documentation](#documentation) -+ [Installation](#installation) -+ [Copyright and licence](#copyright-and-licence) -+ [Get in touch](#get-in-touch) -+ [Contributing](#contributing) - -[](TOC) - -# Overview - -Iris implements a data model based on the [CF conventions](http://cfconventions.org/) -giving you a powerful, format-agnostic interface for working with your data. -It excels when working with multi-dimensional Earth Science data, where tabular -representations become unwieldy and inefficient. - -[CF Standard names](http://cfconventions.org/standard-names.html), -[units](https://github.com/SciTools/cf_units), and coordinate metadata -are built into Iris, giving you a rich and expressive interface for maintaining -an accurate representation of your data. Its treatment of data and - associated metadata as first-class objects includes: - - * a visualisation interface based on [matplotlib](https://matplotlib.org/) and - [cartopy](https://scitools.org.uk/cartopy/docs/latest/), - * unit conversion, - * subsetting and extraction, - * merge and concatenate, - * aggregations and reductions (including min, max, mean and weighted averages), - * interpolation and regridding (including nearest-neighbor, linear and area-weighted), and - * operator overloads (``+``, ``-``, ``*``, ``/``, etc.) - -A number of file formats are recognised by Iris, including CF-compliant NetCDF, GRIB, -and PP, and it has a plugin architecture to allow other formats to be added seamlessly. - -Building upon [NumPy](http://www.numpy.org/) and [dask](https://dask.pydata.org/en/latest/), -Iris scales from efficient single-machine workflows right through to multi-core clusters and HPC. -Interoperability with packages from the wider scientific Python ecosystem comes from Iris' -use of standard NumPy/dask arrays as its underlying data storage. - - -# Documentation - - Stable docs The documentation for *stable released versions* of Iris, including a user guide, example code, and gallery. - - Latest docs The documentation for the *latest development version* of Iris. - - -# Installation - -The easiest way to install Iris is with [conda](https://conda.io/miniconda.html): - - conda install -c conda-forge iris - -Detailed instructions, including information on installing from source, -are available in the -[documentation](https://scitools-iris.readthedocs.io/en/latest/installing.html). - -# Get in touch - - * Report bugs, or suggest new features using an Issue or Pull Request on [Github](https://github.com/SciTools/iris). You can also comment on existing Issues and Pull Requests. - * For discussions from a user perspective you could join our [SciTools Users Google Group](https://groups.google.com/forum/#!forum/scitools-iris). - * For those involved in developing Iris we also have an [Iris Developers Google Group](https://groups.google.com/forum/#!forum/scitools-iris-dev). - * [StackOverflow](https://stackoverflow.com/questions/tagged/python-iris) For "How do I?". - -# Copyright and licence - -Iris may be freely distributed, modified and used commercially under the terms -of its [GNU LGPLv3 license](COPYING.LESSER). - -# Contributing -Information on how to contribute can be found in the [Iris developer guide](https://scitools.org.uk/iris/docs/latest/developers_guide/index.html). - -(C) British Crown Copyright 2010 - 2020, Met Office +

+See the documentation for the latest development version of Iris. +

diff --git a/docs/iris/src/index.rst b/docs/iris/src/index.rst index 22e4715988..5343391332 100644 --- a/docs/iris/src/index.rst +++ b/docs/iris/src/index.rst @@ -9,7 +9,7 @@ Iris Documentation .. todolist:: -**A powerful, format-agnostic, community-driven Python library for analysing +**A powerful, format-agnostic, community-driven Python package for analysing and visualising Earth science data.** Iris implements a data model based on the `CF conventions `_ diff --git a/docs/iris/src/userguide/citation.rst b/docs/iris/src/userguide/citation.rst index 7ce0a8ffc0..56eab0a4eb 100644 --- a/docs/iris/src/userguide/citation.rst +++ b/docs/iris/src/userguide/citation.rst @@ -4,22 +4,23 @@ Citing Iris =========== -If Iris played an important part in your research then please add us to your reference list by using one of the recommendations below. +If Iris played an important part in your research then please add us to your +reference list by using one of the recommendations below. ************ -BibTeX entry +BibTeX entry ************ For example:: @manual{Iris, author = {{Met Office}}, - title = {Iris: A Python library for analysing and visualising meteorological and oceanographic data sets}, + title = {Iris: A Python package for analysing and visualising meteorological and oceanographic data sets}, edition = {v1.2}, year = {2010 - 2013}, address = {Exeter, Devon }, url = {http://scitools.org.uk/} - } + } ******************* @@ -45,7 +46,7 @@ Suggested format:: For example:: - Iris. Met Office. git@github.com:SciTools/iris.git 06-03-2013 + Iris. Met Office. git@github.com:SciTools/iris.git 06-03-2013 .. _How to cite and describe software: http://software.ac.uk/so-exactly-what-software-did-you-use