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.

Sign up for GitHub

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

Updated the README, and copied that over to the iris docs homepage. #3045

Merged
merged 1 commit into from
Jun 1, 2018
Merged

Updated the README, and copied that over to the iris docs homepage. #3045

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<h1 align="center">
<a href="https://scitools.org.uk/iris/docs/latest/" style="display: block; margin: 0 auto;">
<img src="https://raw.githubusercontent.com/pelson/iris/markdown_readme/docs/iris/src/_static/logo_banner.png"
<img src="https://raw.githubusercontent.com/SciTools/iris/master/docs/iris/src/_static/logo_banner.png"
style="max-width: 40%;" alt="Iris"></a><br>
</h1>

Expand Down Expand Up @@ -58,7 +58,7 @@ representations become unwieldy and inefficient.
[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:
associated metadata includes:

* aggregations and reductions (min, max, (area-)weighted mean, etc.)
* interpolation and regridding (nearest-neighbor, linear, area-weighted, etc.)
Expand Down
46 changes: 36 additions & 10 deletions docs/iris/src/_templates/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,18 +73,48 @@
{% block body %}


<p style="font-style: italic; font-size: larger;">
Iris seeks to provide a powerful, easy to use, and community-driven Python library for analysing and visualising meteorological and oceanographic data sets.


<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.
It excels when working with multi-dimensional Earth Science data, where tabular
representations become unwieldy and inefficient.
</p>
<p>
With Iris you can:
<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:
</p>
<ul>
<li>Use a single API to work on your data, irrespective of its original format.
<li>Read and write (CF-)netCDF, GRIB, and PP files.</li>
<li>Easily produce graphs and maps via integration with matplotlib and cartopy.</li>
<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>
</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
<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.
</p>

<div style="float:right; padding-top: 50px; padding-right: 10px;">
<div class="slideshow"></div>
<div id="sliderNav" align="center"></div>
</div>

<div style="float: left;">
<ul style="list-style: none; margin-left: -15px; margin-right: 0px; margin-top: 50px;">
Expand Down Expand Up @@ -119,10 +149,6 @@
</ul>
</div>

<div style="float:right; padding-top: 50px; padding-right: 10px;">
<div class="slideshow"></div>
<div id="sliderNav" align="center"></div>
</div>

<div class="clearer"></div>

Expand Down
2 changes: 2 additions & 0 deletions docs/iris/src/_templates/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,4 +89,6 @@ <h4 style="padding: 0px; max-width: 60ch; margin-top: 0px; margin-bottom: 0px;">
{%- endif %}
</div>

<!-- Include a version switcher to easily move between the documentation of different versions -->
<script type=text/javascript src=/iris/docs/version_switch.js></script>
{% endblock %}