diff --git a/README.md b/README.md index fe869f0461..9c83e78187 100644 --- a/README.md +++ b/README.md @@ -1,72 +1,102 @@ -Iris -==== +

+ + Iris
+

-[![Join the chat at https://gitter.im/SciTools/iris](https://badges.gitter.im/SciTools/iris.svg)](https://gitter.im/SciTools/iris?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) -[![Build Status](https://api.travis-ci.org/repositories/SciTools/iris.svg?branch=master)](https://travis-ci.org/SciTools/iris/branches) -[![DOI](https://zenodo.org/badge/5312648.svg)](https://zenodo.org/badge/latestdoi/5312648) -[![Documentation for master branch ](https://img.shields.io/badge/docs-master-blue.svg)](https://scitools-docs.github.io/iris/master/index.html) +

+ Iris is a powerful, easy to use, and community-driven Python library for + analysing and visualising Earth science data +

-(C) British Crown Copyright 2010 - 2018, Met Office - -Iris is a powerful, easy to use, community-driven Python library for -analysing and visualising meteorological and oceanographic data sets. +

+ + +conda-forge downloads + +Latest version + +Commits since last release + +# contributors + +Travis-CI + +zenodo +

+
+ -Installation ------------- +

Table of contents

-Provided all of the dependencies are satisfied, Iris can be installed -using the following command: +[](TOC) - python setup.py install ++ [Overview](#overview) ++ [Documentation](#documentation) ++ [Installation](#installation) ++ [Copyright and licence](#copyright-and-licence) -For more detailed instructions, including details of the dependencies, -please see INSTALL. +[](TOC) +# Overview -What's new ----------- +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. -A discussion of recent changes is given by the -"What's new" document: +[CF Standard names](http://cfconventions.org/standard-names.html), +[units](https://github.com/SciTools/cf_units), and coordinate metadata +are built-in to Iris, giving you a rich and expressive interface for maintaining +an accurate representation of your data. Its first-class treatment of data and +associated metadata, includes: -- http://scitools.org.uk/iris/docs/latest/whatsnew/index.html + * aggregations and reductions (min, max, (area-)weighted mean, etc.) + * interpolation and regridding (nearest-neighbor, linear, area-weighted, etc.) + * operator overloads (``+``, ``-``, ``*``, ``/``, etc.) + * merge and concatenate + * subsetting and extraction + * unit conversion + * a visualisation interface based on [matplotlib](https://matplotlib.org/) and + [cartopy](https://scitools.org.uk/cartopy/docs/latest/) -If you need complete detail, then please refer to the commit history of -the Iris project on GitHub: +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. -- https://github.com/SciTools/iris +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 -------------- +# Documentation -The full documentation for the current release of Iris, including a user guide, example -code, and gallery, is online at: -- http://scitools.org.uk/iris/ +The documentation for Iris is available at , +including a user guide, example code, and gallery. -There is also a documentation build for the latest code in the main GitHub repository at: -- https://scitools-docs.github.io/iris/master/index.html -(also similarly for other branches) +# Installation +The easiest way to install Iris is with [conda](https://conda.io/miniconda.html): -Copyright and licence ---------------------- + conda install -c conda-forge iris -(C) British Crown Copyright 2010 - 2018, Met Office +Detailed instructions, including information on installing from source, +are available in [INSTALL](INSTALL). -This file is part of Iris. -Iris is free software: you can redistribute it and/or modify it under -the terms of the GNU Lesser General Public License as published by the -Free Software Foundation, either version 3 of the License, or -(at your option) any later version. +# Copyright and licence -Iris is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU Lesser General Public License for more details. +Iris may be freely distributed, modified and used commercially under the terms +of its [GNU LGPLv3 license](COPYING.LESSER). -You should have received a copy of the GNU Lesser General Public License -along with Iris. If not, see . +(C) British Crown Copyright 2010 - 2018, Met Office diff --git a/docs/iris/src/_static/logo_banner.png b/docs/iris/src/_static/logo_banner.png new file mode 100644 index 0000000000..132ba19c22 Binary files /dev/null and b/docs/iris/src/_static/logo_banner.png differ diff --git a/docs/iris/src/_templates/index.html b/docs/iris/src/_templates/index.html index c19e4e5a79..e444067911 100644 --- a/docs/iris/src/_templates/index.html +++ b/docs/iris/src/_templates/index.html @@ -1,9 +1,10 @@ {% extends "layout.html" %} {% set title = 'Iris documentation homepage' %} {% block extrahead %} +{{ super() }} - - + + + + + {% endblock %} @@ -19,13 +22,53 @@ {% block relbar1 %} -
-

-Logo - Iris {{version}} -

+ + + + + + Fork me on GitHub + + + +
+ + Logo + +
+

+ Iris v2.1 +

+

+ a powerful, easy to use, community-driven Python library for analysing and + visualising Earth science data +

+
+ {{ super() }} {% endblock %} diff --git a/setup.py b/setup.py index 347edef3b7..470a7cfbad 100644 --- a/setup.py +++ b/setup.py @@ -230,6 +230,8 @@ def extract_version(): pypi_name = 'scitools-iris' +with open(os.path.join(SETUP_DIR, 'README.md'), 'r') as fh: + description = ''.join(fh.readlines()) setup( name=pypi_name, @@ -237,6 +239,10 @@ def extract_version(): url='http://scitools.org.uk/iris/', author='UK Met Office', author_email='scitools-iris-dev@googlegroups.com', + description="A powerful, easy to use, and community-driven Python " + "library for analysing and visualising Earth science data", + long_description=description, + long_description_content_type='text/markdown', packages=find_package_tree('lib/iris', 'iris'), package_dir={'': 'lib'}, include_package_data=True,