From 2de69febd087a7014daeb0a7e861f84138a0a2e4 Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner Date: Thu, 21 Mar 2013 13:57:04 -0400 Subject: [PATCH] Break out README from setup.py. --- MANIFEST.in | 2 ++ README.rst | 26 ++++++++++++++++++++++++++ setup.py | 28 +--------------------------- 3 files changed, 29 insertions(+), 27 deletions(-) create mode 100644 README.rst diff --git a/MANIFEST.in b/MANIFEST.in index bf423c2..00ed55a 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -25,5 +25,7 @@ include Makefile.in include aksetup_helper.py include README_SETUP.txt +include README.rst + recursive-include bpl-subset/bpl_subset/boost *.h *.hpp *.cpp *.html *.inl *.ipp *.pl *.txt recursive-include bpl-subset/bpl_subset/libs *.h *.hpp *.cpp *.html *.inl *.ipp *.pl *.txt diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..b60105c --- /dev/null +++ b/README.rst @@ -0,0 +1,26 @@ +islpy is a Python wrapper around Sven Verdoolaege's `isl +`_, a library for manipulating sets and +relations of integer points bounded by linear constraints. + +Supported operations on sets include + +* intersection, union, set difference, +* emptiness check, +* convex hull, +* (integer) affine hull, +* integer projection, +* computing the lexicographic minimum using parametric integer programming, +* coalescing, and +* parametric vertex enumeration. + +It also includes an ILP solver based on generalized basis reduction, transitive +closures on maps (which may encode infinite graphs), dependence analysis and +bounds on piecewise step-polynomials. + +Islpy comes with comprehensive `documentation `_. + +*Requirements:* Only the `GNU Multiprecision Library `_ +and its Python wrapper `gmpy `_ (Version 1.x) +are required. A version of isl is shipped with islpy, but optionally +a system-wide one may also be used. + diff --git a/setup.py b/setup.py index 070d01c..e5349b9 100644 --- a/setup.py +++ b/setup.py @@ -96,33 +96,7 @@ def main(): setup(name="islpy", version=conf["VERSION_TEXT"], description="Wrapper around isl, an integer set library", - long_description=""" - islpy is a Python wrapper around Sven Verdoolaege's `isl - `_, a library for manipulating sets and - relations of integer points bounded by linear constraints. - - Supported operations on sets include - - * intersection, union, set difference, - * emptiness check, - * convex hull, - * (integer) affine hull, - * integer projection, - * computing the lexicographic minimum using parametric integer programming, - * coalescing, and - * parametric vertex enumeration. - - It also includes an ILP solver based on generalized basis reduction, transitive - closures on maps (which may encode infinite graphs), dependence analysis and - bounds on piecewise step-polynomials. - - Islpy comes with comprehensive `documentation `_. - - *Requirements:* Only the `GNU Multiprecision Library `_ - and its Python wrapper `gmpy `_ (Version 1.x) - are required. A version of isl is shipped with islpy, but optionally - a system-wide one may also be used. - """, + long_description=open("README.rst", "rt").read(), author="Andreas Kloeckner", author_email="inform@tiker.net", license = "MIT for the wrapper/LGPL for isl", -- GitLab