From acb5f8550c9cf73cd21f28af3ff94a990d67f7aa Mon Sep 17 00:00:00 2001
From: Andreas Kloeckner <inform@tiker.net>
Date: Wed, 28 May 2014 23:41:27 -0500
Subject: [PATCH] Release-readiness tweaks
---
README.rst | 6 +++---
doc/index.rst | 21 ++++++++++++++-----
doc/misc.rst | 54 ++++++++++++++++++++++++++++++------------------
loopy/version.py | 2 +-
setup.py | 6 +++---
5 files changed, 57 insertions(+), 32 deletions(-)
diff --git a/README.rst b/README.rst
index 71b536c67..ff21c116a 100644
--- a/README.rst
+++ b/README.rst
@@ -34,10 +34,10 @@ Places on the web related to Loopy:
* `Python package index <http://pypi.python.org/pypi/loo.py>`_ (download releases) Note the extra '.' in the PyPI identifier!
-* `Documentation <http://documen.tician.de/loopy>`_ (read how things work)
-
.. image:: https://badge.fury.io/py/loo.py.png
:target: http://pypi.python.org/pypi/loo.py
-* `Github <http://github.com/pyopencl/loopy>`_ (get latest source code, file bugs)
+
+* `Documentation <http://documen.tician.de/loopy>`_ (read how things work)
+* `Github <http://github.com/inducer/loopy>`_ (get latest source code, file bugs)
* `Wiki <http://wiki.tiker.net/Loopy>`_ (read installation tips, get examples, read FAQ)
* `Homepage <http://mathema.tician.de/software/loopy>`_
diff --git a/doc/index.rst b/doc/index.rst
index da936cb96..b95183152 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -2,10 +2,10 @@ Welcome to loopy's documentation!
=================================
.. note::
- Loo.py hasn't been released yet. What's documented here generally
- exists as code and has survived some light testing. So if you try
- it and it works for you, great. If not, please do make sure to shoot
- me a message.
+
+ As of May 28, 2014, :mod:`loopy` is release-ready as software, but this
+ documentation is still somewhat of a work in progress. If you're OK with
+ mildly incomplete documentation, please head over to :ref:`installation`.
loopy is a code generator for array-based code in the OpenCL/CUDA execution
model. Here's a very simple example of how to double the entries of a vector
@@ -24,6 +24,18 @@ When you run this script, the following kernel is generated, compiled, and execu
(See the full example for how to print the generated code.)
+Places on the web related to Loopy
+----------------------------------
+
+* `Python package index <http://pypi.python.org/pypi/loo.py>`_ (download releases) Note the extra '.' in the PyPI identifier!
+
+* `Github <http://github.com/inducer/loopy>`_ (get latest source code, file bugs)
+* `Wiki <http://wiki.tiker.net/Loopy>`_ (read installation tips, get examples, read FAQ)
+* `Homepage <http://mathema.tician.de/software/loopy>`_
+
+Table of Contents
+-----------------
+
.. toctree::
:maxdepth: 2
@@ -37,4 +49,3 @@ Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
-
diff --git a/doc/misc.rst b/doc/misc.rst
index 1b2ea07de..8ada6153e 100644
--- a/doc/misc.rst
+++ b/doc/misc.rst
@@ -1,21 +1,40 @@
+.. _installation:
+
Installation
============
-Installation should require no more than the usual::
+This command should install :mod:`loopy`::
+
+ pip install islpy
+
+You may need to run this with :command:`sudo`.
+If you don't already have `pip <https://pypi.python.org/pypi/pip>`_,
+run this beforehand::
+
+ curl -O https://raw.github.com/pypa/pip/master/contrib/get-pip.py
+ python get-pip.py
+
+For a more manual installation, `download the source
+<http://pypi.python.org/pypi/islpy>`_, unpack it, and say::
python setup.py install
+You may also clone its git repository::
+
+ git clone --recursive git://github.com/inducer/loopy
+ git clone --recursive http://git.tiker.net/trees/loopy.git
+
User-visible Changes
====================
-Version 2013.1
+Version 2014.1
--------------
.. note::
This version is currently under development. You can get snapshots from
PyOpenCL's `git repository <https://github.com/inducer/loopy>`_
-* Initial release.
+* Initial release.
.. _license:
@@ -59,27 +78,22 @@ Citing Loopy
If you use loopy for your work and find its approach helpful, please
consider citing the following article.
- TBD, Fixme.
-
-We are not asking you to gratuitously cite PyOpenCL in work that is otherwise
-unrelated to software. That said, if you do discuss some of the development
-aspects of your code and would like to highlight a few of the ideas behind
-PyOpenCL, feel free to cite this article:
+ A. Klöckner. Loo.py: transformation-based code~generation for GPUs and
+ CPUs. Proceedings of ARRAY '14: ACM SIGPLAN Workshop on Libraries,
+ Languages, and Compilers for Array Programming. Edinburgh, Scotland.
- Andreas Klöckner, TBD
+(A link to this article will be available here shortly.)
Here's a Bibtex entry for your convenience::
- @article{kloeckner_pycuda_2012,
- author = {{Kl{\"o}ckner}, Andreas
- and {Warburton}, Timothy
- title = "{TBD}",
- journal = "TBD",
- volume = "TBD",
- number = "TBD",
- pages = "TBD",
- year = "TBD",
- doi = "TBD",
+ @inproceedings{kloeckner_loopy_2014,
+ author = {{Kl{\"o}ckner}, Andreas},
+ title = "{Loo.py: transformation-based code~generation for GPUs and CPUs}",
+ booktitle = "{Proceedings of ARRAY `14: ACM SIGPLAN Workshop
+ on Libraries, Languages, and Compilers for Array Programming}",
+ year = 2014,
+ publisher = "{Association for Computing Machinery}",
+ address = "{Edinburgh, Scotland.}",
}
diff --git a/loopy/version.py b/loopy/version.py
index cf7543aae..0934e945e 100644
--- a/loopy/version.py
+++ b/loopy/version.py
@@ -22,5 +22,5 @@ THE SOFTWARE.
VERSION = (2014, 1)
-VERSION_STATUS = "beta3"
+VERSION_STATUS = ""
VERSION_TEXT = ".".join(str(x) for x in VERSION) + VERSION_STATUS
diff --git a/setup.py b/setup.py
index a2527a157..37737f950 100644
--- a/setup.py
+++ b/setup.py
@@ -20,8 +20,8 @@ exec(compile(version_file_contents, "pyopencl/version.py", 'exec'), ver_dic)
setup(name="loo.py",
version=ver_dic["VERSION_TEXT"],
- description="An automatic loop generator for OpenCL",
- long_description="",
+ description="A code generator for array-based code on CPUs and GPUs",
+ long_description=open("README.rst", "rt").read(),
classifiers=[
'Development Status :: 4 - Beta',
'Intended Audience :: Developers',
@@ -47,7 +47,7 @@ setup(name="loo.py",
],
author="Andreas Kloeckner",
- url="http://pypi.python.org/pypi/pytools",
+ url="http://mathema.tician.de/software/loopy",
author_email="inform@tiker.net",
license="MIT",
packages=[
--
GitLab