From: Dani Date: Mon, 4 Aug 2014 13:24:07 +0000 (+0200) Subject: Change pypol to linpy X-Git-Tag: 1.0~88 X-Git-Url: https://scm.cri.mines-paristech.fr/git/linpy.git/commitdiff_plain/d9ce6feb2d36e40e83326744f1d4ff3890d1874f?hp=5eca735504be3b7c301e2a1fa37712eb88b4ec64 Change pypol to linpy --- diff --git a/doc/domain.rst b/doc/domain.rst index e45b0fb..7098c32 100644 --- a/doc/domain.rst +++ b/doc/domain.rst @@ -17,10 +17,13 @@ Domains Module Returns a domain as disjoint. - .. py:method:: involves_vars(self, vars) - - Returns ``True`` if a domain depends on the given variables. + .. py:method:: num_parameters + + Returns the total number of parameters, input, output or dimensions in a domain. + .. py:method:: involves_dims(self, dims) + + Returns ``True`` if a domain depends on the given dimensions. The unary properties of a domain can be inspected using the following methods. diff --git a/doc/examples.rst b/doc/examples.rst index f3fbfb3..7a390d3 100644 --- a/doc/examples.rst +++ b/doc/examples.rst @@ -1,4 +1,4 @@ -Pypol Examples +Linpy Examples ============== Creating a Polyhedron diff --git a/doc/index.rst b/doc/index.rst index b75e85e..97e6157 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -3,13 +3,13 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to pypol's documentation! +Welcome to Linpy’s documentation! ================================= -Pypol is a Python library for symbolic mathematics. -If you are new to Pypol, start with the Tutorial. +Linpy is a Python library for symbolic mathematics. +If you are new to Linpy, start with the Examples. -This is the central page for all of Pypol's documentation. +This is the central page for all of Linpy’s documentation. Contents: diff --git a/doc/install.rst b/doc/install.rst index 545e773..a19f9ba 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -3,21 +3,27 @@ Installation ------------ -Dependencies -============ +Source +====== -Pypol requires at least Python3.4. Users will first need to install Integer Set Library (isl). The source files of isl are available as a tarball or a git repository. Both are available `here`_ . +Users can install Linpy by cloning the git repository:: + git clone https://scm.cri.ensmp.fr/git/pypol.git -Source -====== +Install +======= -add link to pypi pypol documentation. +…execute `setup.py` -Git -=== +Dependencies +============ + +Linpy has several dependencies. Users will first need to install Integer Set Library (isl). The source files of isl are available as a tarball or a git repository. Both are available `here`_ . + +To use the Linpy plotting function, users need to install matplotlib using instructions in the following `link`_. -add link to git repo .. _here: http://freshmeat.net/projects/isl/ + +.. _link: http://matplotlib.org/faq/installing_faq.html \ No newline at end of file diff --git a/doc/modules.rst b/doc/modules.rst index 2ecf371..0645c7a 100644 --- a/doc/modules.rst +++ b/doc/modules.rst @@ -1,9 +1,9 @@ .. module-docs: -Pypol Module Reference +Linpy Module Reference ====================== -There are four main Pypol modules: +There are four main Linpy modules: .. toctree:: :maxdepth: 2