From 56d774577ed68ce19b19a74d5b9f4afbc8fc3649 Mon Sep 17 00:00:00 2001 From: Phil Elson Date: Fri, 1 Jun 2018 11:52:50 +0100 Subject: [PATCH] Improve the appeal of the landing pages (docs and README) (#3040) * Update the Iris README markdown to be consistent with other SciTools projects. * Gave the package a description (for pypi). * Minor spruce of the Iris docs layout to include the tagline and the forkme button --- README.md | 124 ++++++++++++++++---------- docs/iris/src/_static/logo_banner.png | Bin 0 -> 15685 bytes docs/iris/src/_templates/index.html | 14 ++- docs/iris/src/_templates/layout.html | 53 +++++++++-- setup.py | 6 ++ 5 files changed, 143 insertions(+), 54 deletions(-) create mode 100644 docs/iris/src/_static/logo_banner.png 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 0000000000000000000000000000000000000000..132ba19c22d58c8ca3ce90733d3c7d124891b378 GIT binary patch literal 15685 zcmb_@g;)|JYi#Ts*tIXw(3sKG zl@#>7Cbs;&br@FDk8a%|AUKvWWs`rYB~OO4iSg(y$HS^8-piHCIe+f)RF#`e7EDjD zd(`SZc;?CbTq+?K=JWhu{0l}@QTS5eG0f9EN$D7;h zv@M2YBs=$i-Ike_@$Z||zS_?0Slsh!K|Rp8>#q~QBbtPk1|BRTLhwLXTfhU^jrs>T z@j>t)WyORCn-Ug0RKoxNUJ%+Wvh;^)iZ)I11zu%k<=US=9q_rFoSe+@Y9u5iFL!sH zJ32dABqV6p*Vk)SGknJgAH%169nY)Eosqu2A%#^v$zNy28ZZC(rnjCRnPIU>NLw3% zf|9a~zNbY9pV^ZCT9fSW&kr!e+FKv4?0GRKomDB-OgpNvlg)^PAc9_O{uOf|PH?pcg{yyvy@?pfTscRh}hupAxZ5%5KL2+!E$1@=zs`mC(g-o_79J|A7k zOEyDjXyDbKqE_}9aYo>!_s`$IeMsl^6X2O0M^ii7^EHeqfadC~^y>TNHPot>V?G}( z$y@5;XnjYPouZ`n7FVv8@z2YbXbndb&&L|PZ=K(wq1hHPwm2ftF)_g_(AVI4r->Dz zgjhx2{eAwvW>TG_0fpp^8%pdt+; zW2j0_kX}Jul|7u* zwKzXcQM;L)oxNLRet~CF{Pscub#Xh=JUl!?l9G|wOn!sUr>mPU9QYnq5zxhayL+!{ za_fsRUwCwM?quM850`8@cSJSCDOKNhEY|MR2iCR>JQ;mtMe zU%!gb5MXIIw>h-8wZ*-EANlz+-=EoLCdca3XM*gx$?@?)V`Ii?GQPi`(~DdUT>Tpu zt9(vPKlI=Byna~iINuV4d6S<%FE;^RoR-G$CMijwKz||T&WyaHqX1fqjp)L0^OelT z#s*aF7nem9s4rbrJQms5F2#t~_0e~qPVLf_sJ@G1c^4ZKqpYPx1pkzTh9-Pv}n~@?z6aNks*brDJit zJuM!1DQysg{-LUh$~@qd1C3c)n!&)pz_`+mQu{r5LXHw^YXZkz=f!V?x(N2(@U97J z7awWH6irTjLqk?MIVO+#8+0*P7Z(>cPEOcpP#FzZm*+Y+DZKuab&YjDg(J2`f8)jt zug&6W9Rq{TzcVE!m3W7Thp=UDu0=&fm3eHLY)D|e5UsP_fo~mhWg-)4beL_9#YAk|G7n1hk-^)N{Xs*Q944s`}ebkY)Ht-gD)=wP+PdS zw>MVhKtCPUYVm<=ZaD95mOhX7FhjC*2z$ZE`ryx>9rt5#X~`BAx1-de;FF+{2ZEbBz9Ev3y(!#<)B_#rI+}oC2Pk(6cJ-I`GkKgWpJl*whc4P!IxiF-P`;4 zPMCW571K`hmF&^hWEZ~s+a7B;OAC$4GK|FEzkjz$iGgFKp%G~`^QCwBl_qB}B1_)O ztA_g2rAL=FzGdBgSceX}#bYAeT3ik#L>!WR+VKt^KK{DMS6N|UQfP!G#Z)g|yfAL? z5|#;rF2>5nhRLO!f$V$QeqUQABv$q;JZ8V1A~Wz(V#aqz#!H$JD*KEzEiJ9%>~M2$ zCDrL`Y6s4qN7LS~BBRFcFEuqZ1qB7twnO$}Y?6|6=;-LuQW+`!I-H4?i{E10Z+ObJ z&HnuLOP6ekEMv?Q@wu&KGcJy#PG)rGW|D@>-<5k6m6a?qGU;3#-#R+x;#CX>ld#*tFwpuz7a~VT3Y0#&(?Cpo#)VGPnXD1 zjX69vw)y$x;@h`W(0;NiDkxf8Tg|NRIQYiTJrNTV3td{Wmfq_iFPA*eFDSqbJR8Y` zgB!B8W>fl{h=4!|TI%I)n4HD(_oQf&RW=rn7cb@u@-x~xI*`<~Gl5qZ;jdq>#Ahk7 z1`XMCtn{T04G&`kx4xw0HEe+$;^F!JJnlL+Hk*XRyUUDCrTK*U<=$jVAsVk?7HU`o z*ILt`9%^a)@S|Pj#NCN^X=zIm)-~)c9JZ{svj2A5PyUn-z>!gwhMztAK5T7ohmNc( z+1T9FmTV%&As|T8jep%N=Huhzyf(;^()SdJM20t^Ni!1P<82JMkW5HSj89MR8*^+T zu~JpV&hT2m6;Ib|r_=$Lm6er*l2Vz8 zD$CuneBAl$z;?`D44R!FuHM=s&R!%>+2odrv$If@{W#)S5vz9Ev1@RU1jZdVZo;f< zx~R3e$U6dJxqrKlj8t7*UC9iKDB&scE_!t@6W3ILI!%iUerF)UMkp%ACneo3%Ck-E zLGJIn5)cw9Wa*qty^aoo|6=Fl6hWj3BF82tqZ)mW^+ecnG0~KjmGukRh@+<+Ri8iS zeart4tLPVA`FJz{lGbHc-6S7(cZ%TP;D$wZ4vsx`vH52&UfllUA*J0%Nu*Pvp~|jY zG9CAsS3n?CuV87MmV*qp!i2v+O(OVkbCivR1sz&@czF1n`r9eLweD^;KI1QFcasGg zi?AH@^(o%+J-~oITt7_|+=`ak_l-A2IEip*-dR3p2sKDxGPu?nu!1a-W=etP*6}O(_&=qAJWhuZCc}u z{^-%8xZdTp%}qsXYj*9vl7fO(I6Gggd&tl}B(NFnFBX1>E-5WS#im?R(N&z^&7lnC zKQUoKK}EH%_H)Z4=hG(~Y5~)hcekFAP*H{UrQR8FW6k)3L|$WOXSbMd3-R3g@Tk_6 zs6=Kd^`(UZhrpb)BWW)FTZtlxorOC z7Znwi=SLd@ z+1@lA;84sGUEA{lSPN^ef?d;NjeuHqm%LG8*7#qu5E6=Gyep90ZdKMY@6623ehvD& znxTJ4m@F^>+0%y%>`lW=Ix$ph0kRu9PzvOs*L8ApbBm9Qd-?sl1~7xc%}>R}%6ISLXXoU& z%(q?t45$LC4JJGQhOr7;^6kcBGuYUZ+g$LkExf#Fo|e-#43^n?o?%bB4MTRd8`jA665cAMbR*j8Rcl9s2z{^wzWfxzXm!+bI0J zl&HP1*Ts~X7%aigZfznQ4yZ*zLBZ`P>(Lhr^!@#P3z2t&@MifVJtN{6n3(YZNeSu2 zEPCJaM=x(bMKri9Vg>9)neQT=<4_5hhNq;^WcbjLkjMv@)OMsm4=r!i)Y4+*psy z0yt|??&`1H>XZeQ*^YjPc=BHQjvqEIF78-!pq%4O1C%@NS?11I872(cj&CvawC&Sd z$dlNslUOqkN$3l}cRrgpXBhDX@eTC%tN8oNaOfs!bmAAssj+wW_kUaHjPfQ+8(Ckv zk;-cssh)qyz+){V(R^~^1zX>;xHosQx7gj+r)+3Q1yv1b0ni=^BjfAode6t5k(6fV z8_=kr8$)S(2aUHyQ(4YccP%PBeaiVhH5Imy&E)l;rJls@A3r+E2V{LmiT>5Igaoek zr{mz_DrjpHLyst^N`ysreYc9q(zN%D9`LdmiXXMYscZZbfkaa)CjIJ#=1bhvm^6@{3G!fQo+762!W8&}B=@ls1+w;Ag?0*FtfD8$-gikVScCxiq zaC5r_9Qh+ZDQ?8@vTGLf$V|Weh|$`F^Zh9Ee;9x%tQtS8zLbf#WF)h4aNtL=so~{t z_N1hwZ=R*5rlLAyMxzbS!t%$PWH9_#Zr;R! zs)gqG%B+++i40I^z`sSN#dcyjYi->2hSoG&#j}a$rQYf?OP1#4PYDOSS<~Qzp_&@7 zX1G@G%JZcJHfO2+;twCtpw&Kk^5h_;v$L}z9Ig5T+MY?Gww|^8*jIhd#Gx&FG5WLf zbCx6x)OVu4;|OpzyQU_^GaV}!ol7fC{_$hB0U{o0Ct)k1V(d*)B~?|$qF+7*v2C3DuW3fJ){78)a|g z$9dHxWIJd0YPI2w14*Tdx?bz2fcz7dxZ!Ig>boxb?wIPxHt`*D5DXDO=SARwZ z1eyXm?8iPm|xH!painZl17w4NdS4sLM$~)=OzggliZ^J2?9=Fk(L7)GBrTo1iL3Q zlONE~vD+(MO}P#1F;G)dQvTHHzDOVB9)?Z~Ae!e%WIV^QPwAt2torHKd3TeoK-oE2 zWV#A(YLW#c$I8b?@U;AaJ|3taHa0dEo#@W>l83vyLRi??L*wHS8yj}0(dFuz&@`o% z_g9tC``Yv0pZ9nuhJYR(&jx0GE0;{y5@#Tyle&wjhi!^WObm9ItYVRqn~l=!@rGp_ zjvQxWWBX~jy5|M^jZ!Rt8P5k{GoF}?PK}L)w}%nueEb+1`l8lUz=S5)wEmY}h*@d= zN0yRtwF3QYI54%fwQ!!xC5zpElP@?0ouos}t zXgCD6I5@eQn9yz4@5q|gx?YDxX-E-poWCyYn=Xi;5_=yA%9fY4v7X*5Ah^R=M=e_v ze6^;px3?Vu521h`d>V{~n}UK}K*9?mI}N;(0e-Z$D%ez-eA4In^vf1Lr>q{-HihXDl{z2Hjl%Rz|Pb2j+K?wQ_XNtP~ZS(cQ^^re41ma z7)Z3!HY`d?#*r`ST-^w%i3DkfZphNrzXj4QYMmH%?OIfOo z&&|03Cy|ymqNhh4)qQ~%W7*-G^FU_;dfItwK>F5>{(SkffrV+$*$}7}jlBKuUJ1R+ zX0(DlNqBH#I1?kVj_6}lP&#ba>l=!&tZy_pO1WZbfP)cWVZubzee@{C{OW9UZF_qq z??ZwcOTVP!q$vhamaHrm_ZKffr1dr#H8U~_le^rDJ=rKKwV`7!bHa0&pYnFB^q&7a zF*+L7->(I0ad2?J%*h!_x}fRu@5Ci@*b>Iv8;!hVqJaVBZG7iaXh9g($R-KX{a?dOAV%D;V6dGGJG)J#S+4NQTGoPj`kOS^G%|Pp2u_d+=vndniN$%wiYPdL>tnoSIfzzI4Sd^c%BM`6l zL7zuhMC29ld+78a*ZNQvr`VaB-u9D3ZC2CO#ZFFjH8pG^s2tg4g{HsKdPDl#$Qh*pCaeyE#GrV-&i08 zt!n0fcrZHB_aLYsRC1OZVPCOqMK%!V+g$~2^FJ?f{OYD=YpVEoPvW+@8M5CAij z7GYnsvbQIIh7NNSdIaF4AWhDkqYh9$r)pd_t$Py z-B0#c4+jAfwmuXDE5IDzECg^P3)-7c`m8LCs zK>_D8d-{`f zbc=rdn)UYWq!l0h0S9PksQUHOc=MM~=>`!lZYy*QKp8uMyQ5*ygC5)1-~bkD2f)iu zg9wKU1EB{mK0dx7^0rkj-jw5W7>npdzcdDdKYj8{Ft)R^1ND=Ihc?00>h4><*6&HY zWp=-KtgWqgf0}{Hl6uF96?iv{D!_{kg)`PuFy0jN^n?*voi z^3#NtMVT=GdMtqFppZag-nc$$BU({p0!L@SkuA9wb;v<{0wFyIC~kUsdPPy1Mjpc6 z{FsStserxamt-nAx^GB&j7Qhq^^4ZFw({89D`%&1$rS($fPw>zrZIy)eIc$OcCfyVdX>$QBX^y~*BR^x)#h-D5)25cS~8DWD}k~+4! zysSIGQIObeU>h+V5|<2u+|m-egLJ3N%E^g1466cUE8+cx!XF4*c2Fx}U9vY-Ra91z zkU)m5l$4b%H-8tSwq)8dY-GIyszobJJcyi2>tt)0wW2uY^=m}_h~;R>BNTas;|HXR zj-K9SH6G7M72`?L#e{~g;OyYya_<|oB$H+npL{II5D%~E{R6c_iu3X5DcDx9J-HD zAZ{NVA4f@AfUsuu_;LQUQ>cFS9cW#(rVY`;tcN1FE}@|2QWi6VMF}>*q8nOdK{rtE z8o$%8pYojx8!Utib~+-+8|;w>2ksTs)lrg$u-5SD3e^|CN&`CY7lU$9{Eh7mkDosm zrJovCQ*W|hyNzfY9O|u!N>Czm^*E}Lv_=!`=ZU?`HLlBeNopZ6#oblV?g&!igF~jI zU~O(ld04=1nz7T<(M19)9ZEKbDg+hqqN!t>LQ+!lCQIa_Fuj6wBG5CQ8btL^RlAvdD3%V0DaI=J*W-n#oVfMh!aK^w9LR8Pz zy5$=Q+U!s6_^nF0*MnNH8>xdPZ)TQ}%+|$Ji@!>VcYV8dm63v)I_Jxm!QRVu8R{|u zDmX+RJ}@&#x`%)JDV+a39leauX}0MGy_h{ok~lbFHt3I8SU`a|=Wq7ly2^pI2YV=! z)(kFmadB~E#@y7D0dyhd(z}`;ERo`b&iHQjf6UDTYl--1ikA*agQ53bA zK(xRdaBt3a<~I_dz-ki{74=e2!wW&YdHF9sJH;KfOu(Nq*MpG^5gI=psq(~-bH$`c zSXKF4e^yRmTWJDN6yy1aLFg7rB!$MfdI+BqM~AMcfS4BM5abw z_WKYe)~t)ttM{WXj7Y(mZR$>>0E+q3?yzDu8ayR_ett8L`1Stt1d1M|Hhmnm?>FMf zz#IvfIfErJOXPJ7zA0>VOc{Lo!axFe5nQ`2c8|>Q6x;iC`MFYTq2QA-e4rm7F7^45 zp;$<9?7F+8t>Z1+k+bJ4V0{3y$*$53L7+F9#SRba!7SEFC4oZB(krlu&W6TpZ~w>q zux^_NaqT6jbbGnvtgV{LXq<_-C^_!#-QMVMCC%ca%0`d|oC5yR*ZK7%aClvwu9i7Y zOPYlfw$3#AmU(rJDM+HBF?>U10iew&DKQHQ5=*APe#Ug@`B{pkEbb45V~Z5Em9j@I zu|WHQynQ{i5U+&@u78fHadGknPfPrb1d<23pB~@K`eg?y8;f1?5*{m)-!3|sYvtU> z)L^B7O`-R29@L{Er?0G0lj1Y-NQ3Fbbu8Krw^T z^|id*R$uMbQQZftw^XE^q_idJ9!zdV~utd$muZY5e4IdHX z;K12r1XWTguL*Rg2mFNn>PhdIIXJF!aB$q@<6HW5{f!zsz$28`{-5E3)aPkrvt+%* zQLWi-3&A%taA_jiqo$&=nyz~R4*7xa4<}Y-PIh)?At4eF_NBjaD6^-8d0$!%Wh<+x zsqKE}+hZjtpnz3_cRe{-jNR*(+OYtZ0VBDYcRSd1SU>EZ&)}}{S-2*ccc&Glilw7Dd3o2Tr>Ca6m9-@lmP0i(n^uwENYb|YMw4XrYDW$uA0Tv%JU0CmTQ`d^7=u}IzPOhk`V&&)W+c~YSt{zGF3mnF$ zkr5~gD9>g~iY1kejerYpc=E}cmDFV<`VBmnM-dbo-gz_O&!UONw&o-sMoj-$40@7+QC?_;ADlk0G z4^mvzHSGfmwH;qPp5HI%CaHO3q9H!W$;Fj5x{2cRkU0?Siq^^x*2-7Bf1i9}a`M8g z-JSiho^bcNyOq29n`&*x&L^zJB0q?iR#sSLWNtufs%VRmTg}zy$zyo{iwu~T3Q`ig zbHT)bU09@~CW~S)*gBepsvM^y0b^m*OgGm;oxXeb4nCp~&m5@MI`uR)2x7)ask}eC^KtB9pKQ7X6woxRD zIYP@agO2i`i;M47Xm@;l(z}K^^*RvoMlO6!N~`7Zuk5-%KaVuIXo`F-!FmqTwL7w zcR-GK&V#lXA|JVVc@eS|s00AOC$|9^Y&1X(B1z2mILY~0IN9a(=3eUG7_t$CFQWo{ z6kNdg#Kgs81}Cs?0if?QaOPg1p_!;WQZqHR)%|3ZDeX-L+O_l{FfU5*vj5YjBqSsr zW0N^ciGs<53+uki!;Jp&#bj!}ahcV1fHW-0z3axDdtY;3gbKzPqC;6jk>=&)RotBe zg&38xQ3?0N>qz8{S99K;k^q^=n2*Y|-h&VXF%Vd4j%R$815-0IcYY0*K~ca%)G_{z zI5EmWB`^S(kAjsT#?no8-4JE+KOoKU+2H13ai#x_@8D_0BjM5nG{JtR;hpCnX!Y}e zIiyz;bTE!MZeUiI2cDgsc~$AY;(u5rq?3`n!mE))g_?+OGiCU0-= zfSko7nqV)@J(Xm|}j%WG;9fNu+{HT3f*5;P(Nhn0F~09KRVKOKBqxJ! z8$`NrLt_5Qm)<3hA*?+JLSMiHEHBOu&DgCfOBaZI`657VL51C`;y6Bn`T0zW+pm5>yC^;|?lEC(D z92|g8U~{MojN>+wr!tS`^ln9VZMFX}NXD%>&4RfBEwN&eQR0qyLKXmEU|+@JZH=6; z76Wou48*c0%mdp-phK3G2{#u;L(BjY<%pYtpJKF3j5ygh6?F5V#P~8kC z2AtU#m@{c|fsClI6zG2W1Z##oN#J)V025;CaKa;7?eHg$$2R6kT0nV30|Tm{AfoJ? z@|Sl_5w1&EtcebOl*V%jtksR^p0ifUCbhTcpy!}`q2XafRJrRw)Xz>g$#f7tZ0zh_ zL6V^E#paqzjROVajBu145v_fdMFCQ4?#(C9WTXyIc<<3ce!=(zWuFzcWB6Vzuw- ztwYXP5Me;K0N4PaASEp=*Fh10w4mtP!TN}E{WLr)PWX=Nh?r!5Y;GTSv&GI42c86f zs+*dgj)A$qD?K@Nu6Cw<>jx7;I^du9`}gmelY2p-4~3WqTnS?2Boj26FWC9;>foA_-XvN$-7Mw#1FuFlj8MF~Kv*e%JLE3kV zZ0C=$AJHS8wnfm#NrG#Ceh;}Ad_KIf@f@s`>2eez6sgN=RSOPlfkOMY0wy>n+M$)j_F8B&5!X45G zBO_|4Hg69nk)hQGC0O*C&`{LYlWvt^~pyt}0G@#bdDRD>udnOhUc z13>gpZG_ROJ(RG5xCC78Cr|Q>QV8FziXB;{FfmK)wTU$XWP$^GYbMjMNZHPg$Kg3I zmdMQ0R8EmqoOrLi4tDx&5#jo*I5hxwcOP<`rTVEmAQs5kBt%?V`TsDhWZYLr>FMqy z=li*L#KiXBXYR~2rcM~gsN{S?-k_uV{yg=&kevJ<|F*ZZK-pmX{r&xK%{&7e0<;Cc zqqTUAy!%u+Pmto6-0{3VQJw2A+}(F^5TC7$K!^}?oWe=h!iJs)VnwZ~Y##C^yO23q z_Q-nfY%TNV#{|3!QVy3d;iUAZX1cnqQrlolz(HLox9AMK7!B-O$A0*^r;di5tmn=K ztN3)`!iY?!lPlv$qu}KPMx0?I0^ttfR%5>VR8f@eAUgrxQ&t}Uoe%IUa4d+nUPHEy zB57)um=6%=g-HG+4L}RQ=iBwf53B53!HD)xNDzEQM#jd1SfC-LGUnLKFM1tC%GxuZ zQOL+zo$Lto-H5}*@yEQW;9n4F^VxacX@&wf(Kj**bP&uRSx-xd2I&F{9AZ|NuEaZ{ zJO#bhBH%53sI47e6%$MCyIYymV+~&tP=2N`O9tQ(Xr3uR%a*~ZEr=>+h77t{`h{9siVOBlH06Wy<( zykD8WZ=LAv_${h*^HypfO3s$K^xbL12J>fO!OEuugt?QMLr_KB|4bAtzNfilhDJssO){74ci@#kx54#6Ny^YF>lT;BMn~^(aPv^$!RbIj z5>ROWaXAg!+qVnwrYJRt9dEl)mnTV0ODiKOX>8S6z)e9R z=#yx746o=rO)yOrjEz&)s@kflJT1U9Rwy>iX=q3*S;Vr8D&Xy)=U=fj1Av(hig(Tu zm;Pc%#?!!zXCRn>%$ix-KlL0H^(>X1XudjcUi|Uy)~=T{DA)7q@owlKkc0mj49*j{ zMkwbA4mI#kO-;>{%6swRL!i9>g9tIP?B&U0SO++jSl6##2ib4oR|)D}LqkJ#KzIiL z{{DA?Uco<&2)qysSU1Q|oT9i4O??J0Cix%OiWDZfVBd;IdBuu zLz-7v5_^Qi#lt}Y&xV{RIDSAaJD~6&h;}_^2&d>5&&EGU^g=YkYp3zpd28Y}q~cM= zJVZ<17emwz%-A7l<0ylyw)S1q=VjO0tI1%b%V zkUv97+4}lR%3cTrMXwwqAc<_{s1Ku?wmYOOS!CH1q4UnMTnrRbW;{so3-4%uQY#ge z&`*!_y<(=YjM*EVpbl|}h(fjU+jC-NC08%c0d&m+dRW`oXd4@&sjIJtj#W@>FIjaP zWekkcSi!8r-~$v%3RBZL->_3x$4`$KIDCYkZF# zVeUrI)!_=SANmLm&uMsHswoxyLa@d&gKPw65{k1Gz5#?!yc0frS)!J}Vv$PFZL5^S z%@Z%VxX&k`s}>He7yOa{x5^Nry!-iDEZ|FMM1pbfF7e(=!04!8C#ZmsJ7;BPMsuz8 zn~;gCC9Vfy%r4!mR23}Lfs!XeG`qiy%)wbBfFK6U(OZ(Cnw*OTJJ1=xT&{5H2Q%zr zWhO}Uey7XHpu~qj?B7%%e|XY8T`*T5Yup}{xPo}2$M#eNWcG%I1gsqAKISCMZXWue zl+}qP^>*$&J@rbed9OD;)}TYkL$W@8_N+SZH zuJcLuTrbanhY}1|5^Cx&5T8&e8+0-7`P>6dzb+U4fPtO!7v}$>y7!d6LRlM8Q*MXv zb}cqflAVb`H6$HTlN|6IROP^_2O4|I=#~fIy|vfguFI|x`aF~a^qbD&kgr!WXmr98 zk%do#OvFE*fRI86wlhP7?9(I1kL>qyHTD?*nWQBw=p!X5{cvefL30S#nRzcKJ&2)otv}B2;T<9lf8{Ya@z+wHlTS3XrgXVf$;_YS}u>!u_+8N zuhoYS9`sC7CyQT5sMH|W;0w{y^G>KL{~&UQ9PCtsH#uBqJA}Z1gP^jb&#v4c9S_qC z${q@B;pGb)NiFPK4M_-<90kaQfXj!D29(rmG3E~B#^9;*@L?3_(K+??sS_Htc{`wn`v-(e z$cr1M|0lVlpfY5B2Ul#$Z@9fDfjbSN24v5p^NHMWWBq>r{5hD>HD&j!$&M#{ z*n>kuL7A5a`EEyYz!M=vCJ)9EjJkr2HK+F*jEV2xLDQ7Rm4q+|Q18&br#V&X0unf} z!s&}~kBdzz?I!X{!QV$^76C~rV)1o z=UO}GEDleL@^R>U!lI(rqB>D`jlhmV+K7dj`K87fbYgJBL7sv{y&?n&-{f^X#b?i0 zS4!!(YS?YVuW?@|bBe>kCh#tjfn=YV17%2FUB`X`jE@p)ZlFA1DWAP%-%QfrfXuUE zT`2@C-#twZkI!y432!@vQbB<^zYIB z)c`UL`h%rdD(VS&Kd3xlg1S2r1-Umsu?24o2@VVdQ2_h84Xenk;+6rO^ga4BPx)Y1 zH4-Ks3`Q!BPLS0CeIfM>?Ql2kHrj4G(`DRf6!3$_?6O4E4N0f0-+-A9G201?u$w(` z45Tc%zYTJ)B_n8b~KUIa3l6Tu0;PA1Q>R?FKXbvoL8?!?FB#IuQ8r0p|VNFZP%BIASt7 zB1Ql0CpYJ=J{6(?p|1VmKsp!JS^=JCcqYreD&%rXs|$lE{^|4Q z13jtEpN_(=x&`|B7aS~irqbr%1|)Eo&-gGDauv5_J6u23@>I3Y&lUWDT-zPTsTR1G z48FHthG6nwv(}I{R_H0(>9o7B-1+#xE~J!(!px1YC5fxl{N38x0&KJx!W|@h_l%gT?{J3UW#61B!n<5hB+Em3?O9J@m+!3STF)a^&G zt6tYNqMrOd*%xxFrY_vh6$+M1$~gC(_wMNE_!2+R!u(2t$%8F)YqENza1gDb@Mrk- zZ2&!1kiZg^d%$-zxVZP>>(>OauK8~aj1sO$#vK4ysEj9Z^XknvlC{GN?ztTWX$ox) z$d!=5ldwRGoXj8vwDoB(U5L(HZRK5_@qCc)ehlL3k@L~AG5Dc?4*za^IWEthbrjbn((PrE)yvu9;I;&6XQJPT&KAFC3`_SLfisrfwk>WI&~ z8=!8ic{;u>kIStgihY*h9cr|*3lhljI>(AnPG@-B`Fbo)$m*7$hhB=|5!~QXraRCg zl!-%HGi|#aLT&aTcdba2Dp?(GhC|o_{ z(nmh(@Cg;0LJ7ONnocwU`W%dD%B>N&x6nD6oE1&_c*?C}l7ZUF?pA^HV<8&UT?=$m zKR5;eS!&4RQ}MN=IyI>udtd(ZW{~munSUT=@JvpaEKPtkvS7%{y2f+IOl*Oc=HFb2 zdm+xA)76oaxceGOEJ?_1g3h;3tgXR9iv4znQQR2~C>Qj)leL^!uP)=}fQ#t%2Y%k^ zAscmZ-JNMdQ%_6*W;PuDe)!*Qmp0E(w_VahAh3iw;$9dHy2bd{C!mvn-L3TaaZWP% za?|53f6q;Gk|GWzqXjD?A&D?QlYVc$?+y4Z4__ z&pHR#68(42KtHH4XHAQw3DL{a5utEotCC5U27z-AYVHHXIb)nrH$pa{GIl%uJH7yz zGZScfjv=kkaCx=~cZijb9zn!7e@i}JG4y^st7mP>*`HE%AINTJ1f1FanW&74u}8hd zNLQ2p`R;re6G%mo8V|s(04WQaXKPVu(}tTI42@3sNs>(@Edp=L$@dl9?PLXm&}^6& zECk5v%tQ89(bkq5ps - + + + + + {% 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,