Skip to content

Commit

Permalink
[DOC] Iris Introduction updates (#3052)
Browse files Browse the repository at this point in the history
Update the introduction of Iris content.
  • Loading branch information
DPeterK authored and pelson committed Jun 7, 2018
1 parent 5726656 commit ccc5d92
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 28 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,32 +50,32 @@
# 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.
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-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:
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:

* 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/)
[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/),
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.
Interoperability with packages from the wider scientific Python ecosystem comes from Iris'
use of standard NumPy/dask arrays as its underlying data storage.


# Documentation
Expand Down
28 changes: 14 additions & 14 deletions docs/iris/src/_templates/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -68,38 +68,38 @@

<p>
Iris implements a data model based on the <a href="http://cfconventions.org/">CF conventions</a>
giving you a powerful, format-agnostic, interface for working with your data.
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.
</p>
<p>
<a href="http://cfconventions.org/standard-names.html">CF Standard names</a>,
<a href="https://github.com/SciTools/cf_units">units</a>, 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:
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:
</p>
<ul>
<li>aggregations and reductions (min, max, (area-)weighted mean, etc.)</li>
<li>interpolation and regridding (nearest-neighbor, linear, area-weighted, etc.)</li>
<li>operator overloads (<code>+</code>, <code>-</code>, <code>*</code>, <code>/</code>, etc.)</li>
<li>merge and concatenate</li>
<li>subsetting and extraction</li>
<li>unit conversion</li>
<li>a visualisation interface based on <a href="https://matplotlib.org/">matplotlib</a> and
<a href="https://scitools.org.uk/cartopy/docs/latest/">cartopy</a></li>
<a href="https://scitools.org.uk/cartopy/docs/latest/">cartopy</a>,</li>
<li>unit conversion,</li>
<li>subsetting and extraction,</li>
<li>merge and concatenate,</li>
<li>aggregations and reductions (including min, max, mean and weighted averages),</li>
<li>interpolation and regridding (including nearest-neighbor, linear and area-weighted), and</li>
<li>operator overloads (<code>+</code>, <code>-</code>, <code>*</code>, <code>/</code>, etc.).</li>
</ul>
<p>
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.
</p>
<p>
Building upon <a href="http://www.numpy.org/">numpy</a> and
Building upon <a href="http://www.numpy.org/">NumPy</a> and
<a href="https://dask.pydata.org/en/latest/">dask</a>,
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.
Interoperability with packages from the wider scientific Python ecosystem comes from Iris'
use of standard NumPy/dask arrays as its underlying data storage.
</p>

<div style="float:right; padding-top: 50px; padding-right: 10px;">
Expand Down

0 comments on commit ccc5d92

Please sign in to comment.